Skip to content

Commit 1766b33

Browse files
author
Thom Seddon
committed
Improve README
Add features/limitations + define what "client" returned from getClient should look like
1 parent 6c59d94 commit 1766b33

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

Readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ After running with node, visting http://127.0.0.1:3000 should present you with a
3838

3939
Note: As no model was actually implemented here, delving any deaper, i.e. passing an access token, will just cause a server error. See below for the specification of what's required from the model.
4040

41+
## Features
42+
43+
- Supports password and extension (custom) grant types
44+
- Implicitly supports any form of storage e.g. PostgreSQL, MySQL, Mongo, Redis...
45+
- Full test suite
46+
47+
## Limitations
48+
49+
- Does not yet support authorization code grant type
50+
4151
## Options
4252

4353
- `model` `Object` Model object (see below)
@@ -74,6 +84,10 @@ A model must provide the following methods:
7484
- `error` `Mixed` Truthy to indicate an error
7585
- `client` `Object|Boolean` The client retrieved from storage or falsey to indicate an invalid client (saved in req.client)
7686

87+
`client` should, at least, take the form:
88+
89+
- `client_id` `String` Client id
90+
7791
### grantTypeAllowed(clientId, grantType, callback)
7892
- `clientId` `String`
7993
- `grantType` `String`

0 commit comments

Comments
 (0)