Introduction
This is the README for the Slide Server client API.
Purpose
This library is meant to abstract some of the ugliness
involved in maintaining state with the socket server. Please
see the docs
directory for full API documentation in HTML
format. If you prefer to use the Promises style instead of
typical Node callbacks, simply omit the callback parameter
in any function, and replace the corresponding functionName
with functionNameAsync
in your code.
Setup
- Clone this repository into some directory.
- Download the newest version of Node.JS.
- Run
npm install
in the same directory from Step One. - Run
npm run documentation
to generate the newest docs.
Contact
Contact Sanjay for more details.