add readme

This commit is contained in:
Timo Hocker 2020-03-06 08:29:01 +01:00
parent d5a0207af9
commit 8834917613

15
README.md Normal file
View 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');
```