diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a877c1 --- /dev/null +++ b/README.md @@ -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'); +```