Skip to content

Commit eed4d8f

Browse files
author
Kadi Kraman
authored
Merge pull request #528 from FormidableLabs/chore/update-readme
Add comment for supporting auth code flow in the readme
2 parents 2348719 + e95b2bd commit eed4d8f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ React Native bridge for [AppAuth-iOS](https://github.com/openid/AppAuth-iOS) and
1717
This library _should_ support any OAuth provider that implements the
1818
[OAuth2 spec](https://tools.ietf.org/html/rfc6749#section-2.2).
1919

20-
### Tested OpenID providers:
20+
We only support the [Authorization Code Flow](https://oauth.net/2/grant-types/authorization-code/).
21+
22+
### Tested OpenID providers
2123

2224
These providers are OpenID compliant, which means you can use [autodiscovery](https://openid.net/specs/openid-connect-discovery-1_0.html).
2325

@@ -30,7 +32,7 @@ These providers are OpenID compliant, which means you can use [autodiscovery](ht
3032
- [Azure Active Directory](https://docs.microsoft.com/en-us/azure/active-directory) ([Example configuration](./docs/config-examples/azure-active-directory.md))
3133
- [AWS Cognito](https://eu-west-1.console.aws.amazon.com/cognito) ([Example configuration](./docs/config-examples/aws-cognito.md))
3234

33-
### Tested OAuth2 providers:
35+
### Tested OAuth2 providers
3436

3537
These providers implement the OAuth2 spec, but are not OpenID providers, which means you must configure the authorization and token endpoints yourself.
3638

@@ -249,14 +251,14 @@ are not distributed as part of the bridge.
249251

250252
AppAuth supports three options for dependency management.
251253

252-
1. **CocoaPods**
254+
1. **CocoaPods**
253255

254256
```sh
255257
cd ios
256258
pod install
257259
```
258260

259-
2. **Carthage**
261+
2. **Carthage**
260262

261263
With [Carthage](https://github.com/Carthage/Carthage), add the following line to your `Cartfile`:
262264

@@ -268,7 +270,7 @@ AppAuth supports three options for dependency management.
268270

269271
Add a copy files build step for `AppAuth.framework`: open Build Phases on Xcode, add a new "Copy Files" phase, choose "Frameworks" as destination, add `AppAuth.framework` and ensure "Code Sign on Copy" is checked.
270272

271-
3. **Static Library**
273+
3. **Static Library**
272274

273275
You can also use [AppAuth-iOS](https://github.com/openid/AppAuth-iOS) as a static library. This
274276
requires linking the library and your project and including the headers. Suggested configuration:

0 commit comments

Comments
 (0)