updates readme with license and dependency info

This commit is contained in:
Todd Treece 2015-08-01 23:38:33 -04:00
parent dfc5a0887e
commit 45851d4fd9

View file

@ -2,6 +2,16 @@
A Node.js package for accessing NPR APIs.
## Requirements
This module is a [npm](https://www.npmjs.org) package, and requires
the latest stable version of [node.js](https://nodejs.org).
```
$ node -v
v0.12.7
```
## Installation
```
@ -16,6 +26,9 @@ are more examples in the `test` directory.
**Example:** getting recommendations for your user
```
// paste into a file called index.js,
// and edit the credentials to match
// your account info.
var NPR = require('npr-api');
var npr = NPR({
@ -32,3 +45,18 @@ npr.one.init()
}).catch(console.err);
```
Then you can run this example by running:
```
$ node index.js
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing
coding style. Add unit tests for any new or changed functionality.
Lint and test your code using [Gulp](http://gulpjs.com/).
## License
Copyright (c) 2015 Adafruit Industries. Licensed under the MIT license.