Skip to content

Commit ff8cdad

Browse files
committed
docs: add missing adapters and getting started guide
1 parent 1da9837 commit ff8cdad

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

docs/docs/adapters.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
Adapters
33
==========
44

5-
The *oauth2-server* module is typically not used directly but through one of the available adapters, converting the interface to a suitable one for the HTTP server framework in use.
5+
The *@node-oauth/oauth2-server* module is typically not used directly but through one of the available adapters, converting the interface to a suitable one for the HTTP server framework in use.
66

7-
.. framework-agnostic but there are several officially supported adapters available for popular HTTP server frameworks such as Express_ and Koa_.
7+
.. framework-agnostic but there are several officially supported adapters available for popular HTTP server frameworks such as Express_ and Koa_ (not maintained by us).
88
99
- express-oauth-server_ for Express_
1010
- koa-oauth-server_ for Koa_
1111

12-
.. _express-oauth-server: https://npmjs.org/package/express-oauth-server
12+
.. _express-oauth-server: https://www.npmjs.com/package/@node-oauth/express-oauth-server
1313
.. _Express: https://npmjs.org/package/express
1414
.. _koa-oauth-server: https://npmjs.org/package/koa-oauth-server
1515
.. _Koa: https://npmjs.org/package/koa
@@ -32,5 +32,5 @@ Adapters typically do the following:
3232

3333
- Copy all fields from the :doc:`Response </api/response>` back to the framework-specific request object and send it.
3434

35-
Adapters should preserve functionality provided by *oauth2-server* but are free to add additional features that make sense for the respective HTTP server framework.
35+
Adapters should preserve functionality provided by *@node-oauth/oauth2-server* but are free to add additional features that make sense for the respective HTTP server framework.
3636

docs/docs/getting-started.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ Installation
99

1010
oauth2-server_ is available via npm_.
1111

12-
.. _oauth2-server: https://npmjs.org/package/oauth2-server
12+
.. _oauth2-server: https://www.npmjs.com/package/@node-oauth/oauth2-server
1313
.. _npm: https://npmjs.org
1414

1515
.. code-block:: sh
1616
17-
$ npm install oauth2-server
17+
$ npm install @node-oauth/oauth2-server
1818
19-
.. note:: The *oauth2-server* module is framework-agnostic but there are several officially supported adapters available for popular HTTP server frameworks such as Express_ and Koa_. If you're using one of those frameworks it is strongly recommended to use the respective adapter module instead of rolling your own.
19+
.. note:: The *@node-oauth/oauth2-server* module is framework-agnostic but there are several officially supported adapters available for popular HTTP server frameworks such as Express_ and Koa_. If you're using one of those frameworks it is strongly recommended to use the respective adapter module instead of rolling your own.
2020

21-
.. _Express: https://npmjs.org/package/express-oauth-server
21+
.. _Express: https://www.npmjs.com/package/@node-oauth/express-oauth-server
2222
.. _Koa: https://npmjs.org/package/koa-oauth-server
2323

2424

@@ -28,13 +28,12 @@ Features
2828
========
2929

3030
- Supports :ref:`authorization code <AuthorizationCodeGrant>`, :ref:`client credentials <ClientCredentialsGrant>`, :ref:`refresh token <RefreshTokenGrant>` and :ref:`password <PasswordGrant>` grant, as well as :ref:`extension grants <ExtensionGrants>`, with scopes.
31-
- Can be used with *promises*, *ES6 generators* and *async*/*await* (using Babel_).
31+
- Can be used with *promises*, *ES6 generators* and *async*/*await*.
3232
- Fully :rfc:`6749` and :rfc:`6750` compliant.
3333
- Implicitly supports any form of storage, e.g. *PostgreSQL*, *MySQL*, *MongoDB*, *Redis*, etc.
3434
- Complete `test suite`_.
3535

36-
.. _Babel: https://babeljs.io
37-
.. _test suite: https://github.com/oauthjs/node-oauth2-server/tree/master/test
36+
.. _test suite: https://github.com/node-oauth/node-oauth2-server/tree/master/test
3837

3938

4039
.. _quick-start:
@@ -46,7 +45,7 @@ Quick Start
4645

4746
::
4847

49-
const OAuth2Server = require('oauth2-server');
48+
const OAuth2Server = require('@node-oauth/oauth2-server');
5049

5150
const oauth = new OAuth2Server({
5251
model: require('./model')
@@ -78,7 +77,7 @@ Quick Start
7877

7978
::
8079

81-
const AccessDeniedError = require('oauth2-server/lib/errors/access-denied-error');
80+
const AccessDeniedError = require('@node-oauth/oauth2-server/lib/errors/access-denied-error');
8281

8382
oauth.authorize(request, response)
8483
.then((code) => {

0 commit comments

Comments
 (0)