@simple-login/sdk 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,13 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
Official SDK for Simple Login authentication.
|
|
4
4
|
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
1. Create an account at [simple-login.com](https://simple-login.com)
|
|
8
|
+
2. Create an application to get your `clientId` and `clientSecret`
|
|
9
|
+
3. Install the SDK and configure it with your credentials
|
|
10
|
+
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
7
13
|
```bash
|
|
8
14
|
npm install @simple-login/sdk
|
|
9
15
|
```
|
|
10
16
|
|
|
11
|
-
##
|
|
17
|
+
## Configuration
|
|
18
|
+
|
|
19
|
+
### Using environment variables (recommended)
|
|
20
|
+
|
|
21
|
+
Set these environment variables and the SDK will auto-detect them:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
SIMPLELOGIN_CLIENT_ID=your-client-id
|
|
25
|
+
SIMPLELOGIN_CLIENT_SECRET=your-client-secret
|
|
26
|
+
SIMPLELOGIN_REDIRECT_URI=https://your-app.com/callback
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { SimpleLogin } from '@simple-login/sdk'
|
|
31
|
+
|
|
32
|
+
const client = new SimpleLogin()
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Explicit configuration
|
|
36
|
+
|
|
37
|
+
You can also pass the config directly (this overrides environment variables):
|
|
12
38
|
|
|
13
39
|
```typescript
|
|
14
40
|
import { SimpleLogin } from '@simple-login/sdk'
|