nea-helpers/README.md

Collection of helpers for developing a Nymi Enabled Application (NEA)

# node-nea-helpers
NEA Helpers is a collection of classes and utilty functions to help developing NEAs in NodeJS. They handle a lot of the low level API handling and reduce recurring boilerplate code in your NEAs.  
 
Please refer to the official [Nymi Github](https://github.com/Nymi/JSON-API) or [SDK Documentation](https://downloads.nymi.com/sdkDoc/latest/index.html) for details about Nymi Enabled Applications (NEAs).
  
## Support
All Platforms supported by the Nymi SDK 4.1 should be supported by this module.

Tested on Windows 7 64bit, macOS Sierra 10.12.2, macOS Sierra 10.12.3 and macOS Sierra 10.12.4.

##### Apple Mac OS
 - OS X Yosemite (10.10)
 - OS X El Capitan (10.11)
 - macOS Sierra (10.12.2 or later)
 
##### Microsoft Windows 
 - Windows 10, 8.1, 7 
 - 64bit only
  
## Install
```
npm i nea-helpers
```

## Example usage
Look at my NodeJS port of the Nymi Sample Application [here](https://github.com/PaddeK/node-napi-sampleApp) to see how 
to use the NEA Helpers.

### License

See LICENSE file.