Skip to content
This repository has been archived by the owner on Dec 3, 2021. It is now read-only.

Commit

Permalink
docs: Update docs to remove usage of appName prop
Browse files Browse the repository at this point in the history 
appName prop was only used inside User-Agent header. This is now removed
  • Loading branch information
@adambrgmn
adambrgmn committed Apr 5, 2018
1 parent b1808c2 commit f7cb494
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,16 +169,15 @@ redirected from the OAuth2-provider.

#### Props

| Prop | Type | Required | Default | Description |
| :------------- | :------------------- | :------- | :----------------- | :-------------------------------------------------------------------------------------- |
| `tokenUrl` | `string` | yes | - | The full url to the token endpoint, provided by the service |
| `clientId` | `string` | yes | - | Your client id from the service provider (remember to keep it secret!) |
| `clientSecret` | `string` | yes | - | Your client secret from the service provider (remember to keep it secret!) |
| `redirectUri` | `string` | yes | - | The URL where the provider has redirected your user (used to verify auth) |
| `args` | `object` | no | - | Args will be attatched to the request to the token endpoint. Will be serialized by `qz` |
| `location` | `{ search: string }` | no | - | Used to extract info from querystring [(read more below)](#location-and-querystring) |
| `querystring` | `string` | no | - | Used to extract info from querystring [(read more below)](#location-and-querystring) |
| `appName` | `string` | no | `react-oauth-flow` | App name mainly used to provide a decent User-Agent header on token-request |
| Prop | Type | Required | Default | Description |
| :------------- | :------------------- | :------- | :------ | :-------------------------------------------------------------------------------------- |
| `tokenUrl` | `string` | yes | - | The full url to the token endpoint, provided by the service |
| `clientId` | `string` | yes | - | Your client id from the service provider (remember to keep it secret!) |
| `clientSecret` | `string` | yes | - | Your client secret from the service provider (remember to keep it secret!) |
| `redirectUri` | `string` | yes | - | The URL where the provider has redirected your user (used to verify auth) |
| `args` | `object` | no | - | Args will be attatched to the request to the token endpoint. Will be serialized by `qz` |
| `location` | `{ search: string }` | no | - | Used to extract info from querystring [(read more below)](#location-and-querystring) |
| `querystring` | `string` | no | - | Used to extract info from querystring [(read more below)](#location-and-querystring) |

#### Events

Expand Down Expand Up @@ -284,15 +283,14 @@ overridden when you use the created components.

#### Args

| Arg | Type | Required | Default | Description |
| :--------------------- | :------- | :------- | :----------------- | :-------------------------------------------------------------------------- |
| `options` | `object` | yes | - | Options object |
| `options.authorizeUrl` | `string` | yes | - | The full url to the authorize endpoint, provided by the service |
| `options.tokenUrl` | `string` | yes | - | The full url to the token endpoint, provided by the service |
| `options.clientId` | `string` | yes | - | Your client id from the service provider (remember to keep it secret!) |
| `options.clientSecret` | `string` | yes | - | Your client secret from the service provider (remember to keep it secret!) |
| `options.redirectUri` | `string` | yes | - | The URL where the provider should redirect your users back |
| `appName` | `string` | no | `react-oauth-flow` | App name mainly used to provide a decent User-Agent header on token-request |
| Arg | Type | Required | Default | Description |
| :--------------------- | :------- | :------- | :------ | :------------------------------------------------------------------------- |
| `options` | `object` | yes | - | Options object |
| `options.authorizeUrl` | `string` | yes | - | The full url to the authorize endpoint, provided by the service |
| `options.tokenUrl` | `string` | yes | - | The full url to the token endpoint, provided by the service |
| `options.clientId` | `string` | yes | - | Your client id from the service provider (remember to keep it secret!) |
| `options.clientSecret` | `string` | yes | - | Your client secret from the service provider (remember to keep it secret!) |
| `options.redirectUri` | `string` | yes | - | The URL where the provider should redirect your users back |

## License

Expand Down

0 comments on commit f7cb494

Please sign in to comment.