This commit is contained in:
parent
c0811f0f08
commit
73a2631867
30
README.md
30
README.md
@ -1,31 +1,3 @@
|
||||
# @sapphirecode/auth-client-helper
|
||||
|
||||
version: 1.1.x
|
||||
|
||||
client helper to authenticate on servers using the auth-server-helper
|
||||
|
||||
## Installation
|
||||
|
||||
npm:
|
||||
|
||||
> npm i --save @sapphirecode/auth-client-helper
|
||||
|
||||
yarn:
|
||||
|
||||
> yarn add @sapphirecode/auth-client-helper
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const client = require('@sapphirecode/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');
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT © Timo Hocker <timo@scode.ovh>
|
||||
Package deprecated due to the current auth-server-helper allowing users to define their own endpoints and not forcing a specific procedure anymore.
|
||||
|
Reference in New Issue
Block a user