Merge pull request #5 from pranaygp/master

Add CONTRIBUTING guide and more

Author: sarcadass

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+As `granim` is a small project with a few maintainers, we'd like to make sure that it's easy for you to contribute, and that it's easy for us to manage incoming PRs. In that interest -
+
+1. Fork the Repo
+2. Clone
+3. Run `npm install`
+4. Make Changes
+5. Add any required tests to the `/test/test.html` file
+6. Run `grunt`
+7. Run `npm start` and check `localhost:8080` to ensure that everything works
+8. Commit and Push
+9. Open a Pull Request
+
+### Guidelines
+
+We'd like to make sure your code is like our:
+
+1. `"use strict";`
+2. Use semicolons `;`
+3. We prefer `'` to `"`
+4. Use 1 tabe for indentation, no spaces
+
+With all of that, you should have a PR submitted and merged in no time.
+
+Thanks for helping us out! :)

README.md

@@ -4,6 +4,13 @@ Create fluid and interactive gradients animations with this small (< 10 kB) js l
 **See the [demo site](http://sarcadass.github.io/granim.js)**.
 
 ## Install
+
+### From npm
+
+Run `npm install granim --save`
+
+### Static
+
 * Download the script in the `dist/` folder
 
 ## How to use

package.json

@@ -6,6 +6,13 @@
   "scripts": {
     "start": "cd docs/ && node server.js"
   },
+  "bugs": {
+    "url": "https://github.com/sarcadass/granim.js/issues"
+  },
+  "repository": {
+    "type" : "git",
+    "url": "https://github.com/sarcadass/granim.js"
+  },
   "httpPort": 8080,
   "keywords": [
     "gradient",