README and license

Signed-off-by: Matteo Collina <[email protected]>

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Platformatic Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,11 +1,19 @@
-# oauth-interceptor
+# undici-oauth-interceptor
 
 Manages an access token and automatically sets the `Authorization` header on any
 request that is going to a limited set of domains.
 
+## Install
+
+```bash
+npm i undici undici-oauth-interceptor
+```
+
 ## Usage
 
 ```javascript
+const { Agent } = require('undici')
+const { createOAuthIntercpetor } = require('undici-oauth-interceptor')
 const dispatcher = new Agent({
   intercpetors: {
     Pool: [createOAuthIntercpetor({
@@ -17,7 +25,8 @@ const dispatcher = new Agent({
       // retry the request on
       retryOnStatusCodes: [401],
 
-      // The origins that this interceptor will manage
+      // The origins that this interceptor will add the `Authorization` header
+      // automatically
       origins: []
 
       // OPTIONAL: an initial access token
@@ -30,3 +39,7 @@ const dispatcher = new Agent({
   }
 })
 ``` 
+
+## License
+
+MIT