particle-iot/particle-api-js

Name: particle-api-js

Owner: Particle

Description: JS Library for the Particle API

Created: 2015-09-24 18:06:37.0

Updated: 2018-05-23 18:45:58.0

Pushed: 2018-03-22 14:22:26.0

Homepage: null

Size: 4541

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

particle-api-js

JS Library for the Particle Cloud API for Node.js and the browser

Build Status

Installation

particle-api-js is available from npm to use in Node.js, bower or jsDelivr CDN for use in the browser.

Npm
m install particle-api-js
Bower
wer install particle-api-js
jsDelivr CDN
ipt type="text/javascript" src="//cdn.jsdelivr.net/npm/particle-api-js@7/dist/particle.min.js">
ript>
Documentation

First, read the documentation for Particle API JS on the Documentation website. It contains examples to get started.

For more details, read the API reference on GitHub.

Examples

There are many snippets of using Particle API JS on the Documentation website and some complete examples in the GitHub examples directory.

Building

Make your changes to the files in the src directory, then from the project directory run:

m run compile && npm run build

The dist directory will contain the compiled and minified files that can be included in your project.

Run tests to make sure your changes are good:

m test

Update the API docs with your changes:

m run docs
License

Copyright © 2016 Particle Industries, Inc. Released under the Apache 2.0 license. See LICENSE for details.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.