add readme
This commit is contained in:
parent
d5a0207af9
commit
8834917613
15
README.md
Normal file
15
README.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Auth Client Helper
|
||||||
|
|
||||||
|
a module to make logging in to servers using the auth-server-helper easier
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```js
|
||||||
|
const client = require('@scode/auth-client-helper');
|
||||||
|
|
||||||
|
// if using in the browser, will send a request to the current host
|
||||||
|
const session_id = client.login('user','passw');
|
||||||
|
|
||||||
|
// specify a host manually
|
||||||
|
const session_id = client.login('user','passw','https://example.com');
|
||||||
|
```
|
Reference in New Issue
Block a user