You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/node-oauth/node-oauth2-server/actions/workflows/tests-release.yml)
[](https://www.repostatus.org/#active)
@@ -19,7 +20,8 @@ NOTE: This project has been forked from [oauthjs/node-oauth2-server](https://git
19
20
npm install @node-oauth/oauth2-server
20
21
```
21
22
22
-
The *@node-oauth/oauth2-server* module is framework-agnostic but there are several officially supported wrappers available for popular HTTP server frameworks such as [Express](https://npmjs.org/package/express-oauth-server) and [Koa](https://npmjs.org/package/koa-oauth-server). If you're using one of those frameworks it is strongly recommended to use the respective wrapper module instead of rolling your own.
23
+
The `@node-oauth/oauth2-server` module is framework-agnostic but there are several officially supported wrappers available for popular HTTP server frameworks such as [Express](https://www.npmjs.com/package/@node-oauth/express-oauth-server) and [Koa (not maintained by us)](https://npmjs.org/package/koa-oauth-server).
24
+
If you're using one of those frameworks it is strongly recommended to use the respective wrapper module instead of rolling your own.
23
25
24
26
25
27
## Features
@@ -28,25 +30,28 @@ The *@node-oauth/oauth2-server* module is framework-agnostic but there are sever
28
30
- Can be used with *promises*, *Node-style callbacks*, *ES6 generators* and *async*/*await* (using [Babel](https://babeljs.io)).
29
31
- Fully [RFC 6749](https://tools.ietf.org/html/rfc6749.html) and [RFC 6750](https://tools.ietf.org/html/rfc6750.html) compliant.
30
32
- Implicitly supports any form of storage, e.g. *PostgreSQL*, *MySQL*, *MongoDB*, *Redis*, etc.
[Documentation](https://oauth2-server.readthedocs.io) is hosted on Read the Docs.
37
-
38
+
[Documentation](https://node-oauthoauth2-server.readthedocs.io/en/latest/) is hosted on Read the Docs.
39
+
Please leave an issue if something is confusing or missing in the docs.
38
40
39
41
## Examples
40
42
41
-
Most users should refer to our [Express](https://github.com/oauthjs/express-oauth-server/tree/master/examples) or [Koa](https://github.com/oauthjs/koa-oauth-server/tree/master/examples) examples.
43
+
Most users should refer to our [Express (active)](https://github.com/node-oauth/express-oauth-server) or
44
+
[Koa (not maintained by us)](https://github.com/oauthjs/koa-oauth-server/tree/master/examples) examples.
42
45
43
46
More examples can be found here: https://github.com/14gasher/oauth-example
44
47
45
-
## Upgrading from 2.x
48
+
## Migrating from OAuthJs and 3.x
46
49
47
-
This module has been rewritten using a promise-based approach, introducing changes to the API and model specification. v2.x is no longer supported.
50
+
Version 4.x should not be hard-breaking, however, there were many improvements and fixes that may
51
+
be incompatible with specific behaviour in <= 3.x
48
52
49
-
Please refer to our [3.0 migration guide](https://oauth2-server.readthedocs.io/en/latest/misc/migrating-v2-to-v3.html) for more information.
53
+
For more info, please read the [changelog](./CHANGELOG.md) or open an issue, if you think something
0 commit comments