harrogateclient/README.md

A simple node.js client for Kipr Harrogate on their Wallaby's.

# harrogateclient
A simple node.js client for KIPR Harrogate.

## Features
* get users
* add/delete users
* get projects
* add/delete projects
* load files
* add/delete files
* change files

## Installing
using npm:
```
$ npm install harrogateclient
```
## Example
1. require the class
    ```js
    const HarrogateClient = require('harrogateclient')
   ```
2. create an instance
    ```js
    var client = new HarrogateClient('192.168.125.1:8888')
    ```
* get all users
    ```js
    client.getUsers().then(function (users) {
        console.log("==Users==")
        console.log(users)
    })
    ```
* add and delete a user
    ```js
    client.addUser('alex').then(function (user) {
        console.log("==User created==")
        user.delete().then(function () {
            console.log("==User deleted==")
        })
    })
    ```

## Documentation
[Full Documentation](https://github.com/alex-zach/harrogateclient/blob/master/out/doc.md)