Skip to content

Commit e105a13

Browse files
authored
Link to the API docs from the README (#168)
1 parent 9ee67da commit e105a13

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ Easily decode a [JWT](https://jwt.io/) and access the claims it contains.
2323
+ [Cocoapods](#cocoapods)
2424
+ [Carthage](#carthage)
2525
- [**Usage**](#usage)
26-
+ [JWT Parts](#jwt-parts)
27-
+ [Registered Claims](#registered-claims)
28-
+ [Custom Claims](#custom-claims)
29-
+ [Error Handling](#error-handling)
26+
+ [JWT parts](#jwt-parts)
27+
+ [Registered claims](#registered-claims)
28+
+ [Custom claims](#custom-claims)
29+
+ [Error handling](#error-handling)
3030
- [**Support Policy**](#support-policy)
3131
- [**Issue Reporting**](#issue-reporting)
3232
- [**What is Auth0?**](#what-is-auth0)
@@ -84,6 +84,8 @@ Then, run `carthage bootstrap --use-xcframeworks`.
8484
8585
## Usage
8686

87+
**See all the available features in the [API documentation ↗](https://auth0.github.io/JWTDecode.swift/documentation/jwtdecode/)**
88+
8789
1. Import the framework:
8890

8991
```swift
@@ -96,15 +98,15 @@ import JWTDecode
9698
let jwt = try decode(jwt: token)
9799
```
98100

99-
### JWT Parts
101+
### JWT parts
100102

101103
| Part | Property |
102104
|:-------------------|:----------------|
103105
| Header dictionary | `jwt.header` |
104106
| Claims in JWT body | `jwt.body` |
105107
| JWT signature | `jwt.signature` |
106108

107-
### Registered Claims
109+
### Registered claims
108110

109111
| Claim | Property |
110112
|:--------------------------|:-----------------|
@@ -116,7 +118,7 @@ let jwt = try decode(jwt: token)
116118
| **iat** (Issued At) | `jwt.issuedAt` |
117119
| **exp** (Expiration Time) | `jwt.expiresAt` |
118120

119-
### Custom Claims
121+
### Custom claims
120122

121123
You can retrieve a custom claim through a subscript and then attempt to convert the value to a specific type.
122124

@@ -147,7 +149,7 @@ extension JWT {
147149
}
148150
```
149151

150-
### Error Handling
152+
### Error handling
151153

152154
If the JWT is malformed the `decode(jwt:)` function will throw a `JWTDecodeError`.
153155

0 commit comments

Comments
 (0)