Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maxmantz authored Jul 25, 2016
1 parent e18cda9 commit 3348c02
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@ A package for managing OpenID-Connect authentication in ReactJS / Redux apps.
### Installation
`npm install --save redux-oidc`

Then run
#### Peer dependency
This package has [oidc-client-js](https://github.com/IdentityModel/oidc-client-js/tree/master) as its peer dependency.
In order to install this run:

`npm install --save oidc-client`

### Description

This package handles [OpenID-Connect](http://openid.net/connect/) authentication in [redux](http://redux.js.org/) apps. It enables redux apps to authenticate with an external OIDC authentication provider and handles the actions of the OpenID [implicit flow](http://openid.net/specs/openid-connect-implicit-1_0.html).

It is built upon the [oidc-client-js](https://github.com/IdentityModel/oidc-client-js/tree/master) library.
It uses the oidc-client-js library to manage OpenID Connect functionality.

It contains the following parts:
- *oidcMiddleware*: [redux middleware](http://redux.js.org/docs/advanced/Middleware.html) to automatically check whether or not the current user is signed in & trigger the authentication flow,
Expand Down

0 comments on commit 3348c02

Please sign in to comment.