splush
javascript driver for splush
getting started
click here!
usage
cli
splush config (thing) (value)
configures (thing) with the provided (value)
thing
's to configure:
key
- key used for pushing notifications for a given device, get it from hereupstream
- (default https://splush.nikerino.com) - configures the endpoint to push to, useful if you're running your own splush node
example: splush config key MassiveGroundLeafUnder
splush push (optional: msg)
Creates a new push notification, optionally with the given (msg).
example: splush push Good morning!
splush help (command)
Prints this text.
module
// reads config from ~/.splush.jsonconst splush = // can be passed a custom keyconst splush = 'MassiveGroundLeafUnder' // ...or an options objectconst splush = key: 'MassiveGroundLeafUnder' upstream: 'http://localhost:3030' splush
splush([options])
Spawns a new splush instance, options are read from ~/.splush.json
if not provided.
.push([msg])
Creates a new push notification, optionally with the given (msg).
install
cli
# npm install -g splush
module
$ npm install --save splush
license
MIT