From 45851d4fd92d9bc69ab4d56c2343e778b728d450 Mon Sep 17 00:00:00 2001 From: Todd Treece Date: Sat, 1 Aug 2015 23:38:33 -0400 Subject: [PATCH] updates readme with license and dependency info --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index ad82764..c4b0947 100644 --- a/README.md +++ b/README.md @@ -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.