Skip to content

Commit 6b7b15a

Browse files
Add archival / deprecation notice to README.
1 parent 294f03a commit 6b7b15a

1 file changed

Lines changed: 3 additions & 105 deletions

File tree

README.md

Lines changed: 3 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -6,113 +6,11 @@
66

77
> OpenID Connect Relying Party for Node.js and the browser.
88
9-
- [x] Dynamic Configuration and Client Registration
10-
- [x] Authorization Code, Implicit, and Hybrid grants
11-
- [x] Relying Party initiated logout
12-
- [ ] Refresh grant
13-
- [ ] Client Credentials grant
14-
- [ ] Key rotation using JWK `kid` value
15-
- [ ] Session management
16-
- [ ] front- and back-channel logout
17-
- [X] Request parameters as JWT
18-
- [ ] Claims request parameter
19-
- [ ] Claims language tags
20-
- [ ] OAuth 2.0 Bearer Token requests
9+
## Deprecation Notice
2110

22-
## Table of Contents
11+
This repository has been archived, and will no longer be maintained by the Solid Project.
2312

24-
* [Security](#security)
25-
* [Background](#background)
26-
* [Install](#install)
27-
* [Usage](#usage)
28-
* [Node.js](#nodejs)
29-
* [Browser](#browser)
30-
* [Develop](#develop)
31-
* [Maintainers](#maintainers)
32-
* [Contribute](#contribute)
33-
* [MIT License](#mit-license)
34-
35-
## Security
36-
37-
...
38-
39-
## Background
40-
41-
...
42-
43-
## Install
44-
45-
```bash
46-
$ npm install @solid/oidc-rp --save
47-
```
48-
49-
## Usage
50-
51-
### Node.js
52-
53-
```
54-
const RelyingParty = require('@solid/oidc-rp')
55-
```
56-
57-
### Browser
58-
59-
When loaded into an HTML page via `<script src="./dist/oidc.rp.min.js"></script>`,
60-
the library is exposed as a global var, `OIDC`.
61-
62-
63-
## Develop
64-
65-
### Install
66-
67-
```bash
68-
$ git clone git@github.com:solid/oidc-rp.git
69-
$ cd oidc-rp
70-
$ npm install
71-
```
72-
73-
### Build
74-
75-
**Important:**
76-
If you're using this library as a dependency and you plan to use Webpack, don't
77-
forget to add the following lines to your `webpack.config.js` `externals:`
78-
section:
79-
80-
```js
81-
externals: {
82-
'node-fetch': 'fetch',
83-
'@sinonjs/text-encoding': 'TextEncoder',
84-
'whatwg-url': 'window',
85-
'isomorphic-webcrypto': 'crypto'
86-
}
87-
```
88-
89-
To build a Webpack-generated bundle:
90-
91-
```bash
92-
npm run dist
93-
```
94-
95-
### Test
96-
97-
```bash
98-
npm test
99-
```
100-
101-
## Maintainers
102-
103-
* Dmitri Zagidulin
104-
105-
## Contribute
106-
107-
#### Style guide
108-
109-
* ES6
110-
* Standard JavaScript
111-
* jsdocs
112-
113-
### Code of conduct
114-
115-
* @solid/oidc-rp follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.
13+
Active maintenance has been moved to **[interop-alliance/oidc-rp](https://github.com/interop-alliance/oidc-rp)**.
11614

11715
### Contributors
11816

0 commit comments

Comments
 (0)