search

NU-CBITS / PurpleRobotClient

0 stars 0 forks source link

readme

Purple Robot Client

Build Status

A library that simplifies command passing to Purple Robot via its HTTP server and JavaScript API. Scripts are generated as strings and sent as JSON, then deserialized and interpreted by Purple Robot.

Documented source code with examples

Installing

bower install git@github.com:cbitstech/PurpleRobotClient.git#<tagged version>

Where tagged version is the specific version to be installed.

Developing

The first thing to do is install the development dependencies with npm install.

Updating the documentation

grunt document

Creating minified version

grunt minify

Running specs

Note that tests are run against the minified version.

grunt test

Releasing

  1. update version number
  2. grunt
  3. update CHANGELOG.md
  4. commit
  5. tag
  6. merge master into gh-pages branch
  7. push all branches and tags