A Node.js library and CLI tool to send notifications via Notify My Android
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test Update dependencies and add David-DM badge Oct 26, 2014
.coveralls.yml
.gitignore
.jscs.json
.jshintrc
.travis.yml
LICENSE
README.md
npm-shrinkwrap.json
package.json

README.md

node-nma

A Node.js library and CLI tool to send notifications via Notify My Android

npm Version npm Downloads Build Status Coverage Status Dependency Status Documentation Status Open Issues Stories in Ready

Installation

If you want to use the CLI tool, Use the -g flag to install globally.

$ npm install [-g] nma

Code Example

var nma = require("nma");

nma({
  "apikey": "02cfc1a5f4e567929c31c13953e1adef247118562f148f7a",
  "application": "Your App",
  "event": "An Event",
  "description": "And a description of that event...",
  "priority": 0, // Priority
  "url": "http://www.somewebsite.com/",
  "content-type": "text/plain"
}, callback);

Also, apikey can be a list of comma separated keys if you're using multiple keys.

CLI Usage

Follows the NMA API closely:

$ nma -k apikey -a application -e event -d description -p priority -u url -c content-type

Complete usage details via nma --help

Usage: nma [options]

Options:

  -h, --help                 output usage information
  -V, --version              output the version number
  -k, --apikey <key>         API key(s), separated by commas
  -a, --application <app>    Name of the application generating the notification
  -e, --event <event>        Subject of the notification
  -d, --description <desc>   Full text of the notification
  -p, --priority [0]         -2 = Very Low; -1 = Moderate; 0 = Normal; 1 = High; 2 = Emergency
  -u, --url <url>            URL/URI to associate with the notification
  -c, --content-type [type]  Set to "text/html" and basic html will be rendered while displaying the notification

TODO

  • Input validation
  • Constructor to setup some defaults (apikey, application, content-type)
  • Verbose output
  • ??? - Feel free to open an Issue or submit a Pull Request!

License

MIT