From 88349176139efd91bf77b9615de495f57108f908 Mon Sep 17 00:00:00 2001 From: Timo Hocker Date: Fri, 6 Mar 2020 08:29:01 +0100 Subject: [PATCH] add readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md 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'); +```