The SDK to make Resin.io powered JavaScript applications.

Install the Resin SDK by running:

$ npm install --save resin-sdk

We currently only support NodeJS, but there are plans to make the SDK available in the browser as well.

Open doc/ in a web browser to view a detailed documentation of the capabilities offered by the SDK. Notice this is a work in progress and we plan to host the documentation online soon.

You can regenerate the documentation with:

$ gulp jsdoc

Run the test suite by doing:

$ gulp test

• Issue Tracker: github.com/resin-io/resin-sdk/issues
• Source Code: github.com/resin-io/resin-sdk

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

In order to get a nice development workflow where every asset is recompiled automatically on every change, the tests and the linter is ran, run:

$ gulp watch

Documentation is regenerated when releasing a new version, so if you decide to contribute, you don't need to worry about that.

If you're having any problem, please raise an issue on GitHub.

The project is licensed under the MIT license.