Skip to content

Commit

Permalink
docs: added missing mds and changed readme to an initial skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
mauriciovigolo committed Sep 13, 2017
1 parent d675698 commit e28d1bf
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 9 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<a name="0.1.0"></a>
# 0.1.0 (2017-09-12)

Project draft.

Features
---
* ***** -
* ***** -
* ****** -
* ****** -
Empty file added LICENSE.md
Empty file.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,37 @@
Keycloak Angular
========================

# Requirements

1. Easy integration of Keycloak with Angular > v.4 apps.
1. Possibility to initialize in the beginning of the angular app start. [(APP_INITIALIZER)](https://angular.io/api/core/APP_INITIALIZER).
1. Get the init information from default keycloak.json location or in custom path.
1. Init in lazy mode, so the user can navigate in public pages, for example: landing pages. In this mode when a restricted resource will be accessed, it should take the login process.
1. Should deal with authorizations.
1. First version will only consider the Authorization Code flow.
1. Should properly return user infos.
keycloak-js port for Angular > v2 applications.

---
* [About](#about)
* [Install](#install)
* [Setup in Angular](#setup-in-angular)
* [History](#history)
* [License](#license)
---

## About

TODO: Add documentation.

* Easy integration of Keycloak with Angular > v.4 apps.
* Get the init information from default keycloak.json location or in custom path.

## Install

TODO: Add documentation.

## Setup in Angular

TODO: Add documentation.
* Possibility to initialize in the beginning of the angular app start. [(APP_INITIALIZER)](https://angular.io/api/core/APP_INITIALIZER).

## History

TODO: Add documentation.

## License

TODO: Add documentation.

0 comments on commit e28d1bf

Please sign in to comment.