Update README and package.json keywords

hybridgroup · Jun 11, 2015 · ebb13dc · ebb13dc
1 parent 66de35c
commit ebb13dc
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Cylon.js For Raspberry Pi
 
-Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and physical computing using Node.js
+Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things (IoT).
 
 This module provides an adaptor for the Raspberry Pi single board computer (http://www.raspberrypi.org/). It currently works with both the Raspberry Pi & Raspberry Pi 2.
 
@@ -197,65 +197,15 @@ Thank you!
 
 ## Contributing
 
-* All patches must be provided under the Apache 2.0 License
-* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
-* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
-* We will look at the patch, test it out, and give you feedback.
-* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
-* Take care to maintain the existing coding style.
-* Add unit tests for any new or changed functionality & Lint and test your code using [Grunt](http://gruntjs.com/).
-* All pull requests should be "fast forward"
-  * If there are commits after yours use “git rebase -i <new_head_branch>”
-  * If you have local changes you may need to use “git stash”
-  * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+For our contribution guidelines, please go to [https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
+](https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
+).
 
 ## Release History
 
-Version 0.16.0 - Compatibility with Cylon 1.0.0
-
-Version 0.15.3 - Corrected functionality for i2c.
-
-Version 0.15.2 - Remove node-i2c dependency from package, it is now install via script
-
-Version 0.15.1 - Install node-i2c using script based on node version
-
-Version 0.15.0 - Compatibility with Cylon 0.22.0
-
-Version 0.14.1 - Fix pin and pi-blaster compatability for different board revisions
-
-Version 0.14.0 - Compatibility with Cylon 0.21.0
-
-Version 0.13.0 - Compatibility with Cylon 0.20.0
-
-Version 0.12.0 - Compatibility with Cylon 0.19.0
-
-Version 0.11.0 - Compatibility with Cylon 0.18.0
-
-Version 0.10.0 - Compatibility with Cylon 0.16.0
-
-Version 0.9.1 - Add peerDependencies to package.json
-
-Version 0.9.0 - Compatibility with Cylon 0.15.0
-
-Version 0.8.1 - Fix a bug with PWM pins
-
-Version 0.8.0 - Compatibility with Cylon 0.14.0, remove node-namespace.
-
-Version 0.7.0 - Release for cylon 0.12.0
-
-Version 0.6.2 - Fixes bug with connection not being set on adaptor.
-
-Version 0.6.0 - Release for cylon 0.11.0, refactor into pure JavaScript, i2c bugfixes
-
-Version 0.5.0 - Release for cylon 0.10.0
-
-Version 0.4.0 - Release for cylon 0.9.0
-
-Version 0.3.0 - Release for cylon 0.8.0
-
-Version 0.2.0 - Release for cylon 0.7.0
-
-Version 0.1.0 - Initial release
+For the release history, please go to [https://github.com/hybridgroup/cylon-raspi/blob/master/RELEASES.md
+](https://github.com/hybridgroup/cylon-raspi/blob/master/RELEASES.md
+).
 
 ## License
 Copyright (c) 2013-2015 The Hybrid Group. Licensed under the Apache 2.0 license.
diff --git a/RELEASES.md b/RELEASES.md
@@ -0,0 +1,47 @@
+## Release History
+
+Version 0.16.0 - Compatibility with Cylon 1.0.0
+
+Version 0.15.3 - Corrected functionality for i2c.
+
+Version 0.15.2 - Remove node-i2c dependency from package, it is now install via script
+
+Version 0.15.1 - Install node-i2c using script based on node version
+
+Version 0.15.0 - Compatibility with Cylon 0.22.0
+
+Version 0.14.1 - Fix pin and pi-blaster compatability for different board revisions
+
+Version 0.14.0 - Compatibility with Cylon 0.21.0
+
+Version 0.13.0 - Compatibility with Cylon 0.20.0
+
+Version 0.12.0 - Compatibility with Cylon 0.19.0
+
+Version 0.11.0 - Compatibility with Cylon 0.18.0
+
+Version 0.10.0 - Compatibility with Cylon 0.16.0
+
+Version 0.9.1 - Add peerDependencies to package.json
+
+Version 0.9.0 - Compatibility with Cylon 0.15.0
+
+Version 0.8.1 - Fix a bug with PWM pins
+
+Version 0.8.0 - Compatibility with Cylon 0.14.0, remove node-namespace.
+
+Version 0.7.0 - Release for cylon 0.12.0
+
+Version 0.6.2 - Fixes bug with connection not being set on adaptor.
+
+Version 0.6.0 - Release for cylon 0.11.0, refactor into pure JavaScript, i2c bugfixes
+
+Version 0.5.0 - Release for cylon 0.10.0
+
+Version 0.4.0 - Release for cylon 0.9.0
+
+Version 0.3.0 - Release for cylon 0.8.0
+
+Version 0.2.0 - Release for cylon 0.7.0
+
+Version 0.1.0 - Initial release
diff --git a/package.json b/package.json
@@ -13,7 +13,23 @@
     "url": "https://github.com/hybridgroup/cylon-raspi"
   },
 
-  "license": "Apache 2.0",
+  "license": "Apache-2.0",
+
+  "keywords": [
+    "cylon",
+    "cylonjs",
+    "cylons",
+    "robot",
+    "robots",
+    "robotics",
+    "iot",
+    "hardware",
+    "gpio",
+    "i2c",
+    "raspberry pi",
+    "raspberrypi",
+    "raspi"
+  ],
 
   "scripts": {
     "install": "./scripts/install-i2c.sh"