Skip to content

Commit 9edfa2d

Browse files
committed
docs: correct all links in the README
1 parent 0645a02 commit 9edfa2d

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Complete, compliant and well tested module for implementing an OAuth2 server in
66
[![Tests](https://github.com/node-oauth/node-oauth2-server/actions/workflows/tests.yml/badge.svg)](https://github.com/node-oauth/node-oauth2-server/actions/workflows/tests.yml)
77
[![CodeQL Semantic Analysis](https://github.com/node-oauth/node-oauth2-server/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/node-oauth/node-oauth2-server/actions/workflows/codeql-analysis.yml)
88
[![Tests for Release](https://github.com/node-oauth/node-oauth2-server/actions/workflows/tests-release.yml/badge.svg)](https://github.com/node-oauth/node-oauth2-server/actions/workflows/tests-release.yml)
9+
[![Documentation Status](https://readthedocs.org/projects/node-oauthoauth2-server/badge/?version=latest)](https://node-oauthoauth2-server.readthedocs.io/en/latest/?badge=latest)
910
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
1011
![npm Version](https://img.shields.io/npm/v/@node-oauth/oauth2-server?label=version)
1112
![npm Downloads/Week](https://img.shields.io/npm/dw/@node-oauth/oauth2-server)
@@ -19,7 +20,8 @@ NOTE: This project has been forked from [oauthjs/node-oauth2-server](https://git
1920
npm install @node-oauth/oauth2-server
2021
```
2122

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.
2325

2426

2527
## Features
@@ -28,25 +30,28 @@ The *@node-oauth/oauth2-server* module is framework-agnostic but there are sever
2830
- Can be used with *promises*, *Node-style callbacks*, *ES6 generators* and *async*/*await* (using [Babel](https://babeljs.io)).
2931
- Fully [RFC 6749](https://tools.ietf.org/html/rfc6749.html) and [RFC 6750](https://tools.ietf.org/html/rfc6750.html) compliant.
3032
- Implicitly supports any form of storage, e.g. *PostgreSQL*, *MySQL*, *MongoDB*, *Redis*, etc.
33+
- Support for PKCE
3134
- Complete [test suite](https://github.com/node-oauth/node-oauth2-server/tree/master/test).
3235

33-
3436
## Documentation
3537

36-
[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.
3840

3941
## Examples
4042

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.
4245

4346
More examples can be found here: https://github.com/14gasher/oauth-example
4447

45-
## Upgrading from 2.x
48+
## Migrating from OAuthJs and 3.x
4649

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
4852

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
54+
is unexpectedly not working.
5055

5156
## Supported NodeJs versions
5257

0 commit comments

Comments
 (0)