Update docs

Author: sachinchoolur

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+You're more than welcome to contribute to this project. Please note: your code may be used as part of a commercial product if merged.
+
+## Important notes
+Please don't edit files in the `dist` subdirectory as they are generated via npm script. You'll find source code in the `src` subdirectory!
+
+### Code style
+Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
+
+## Modifying the code
+First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
+
+1. Fork and clone the repo.
+1. Run `npm install` to get the project's dependencies
+1. Run `npm run start` to run the dev server. open `http://localhost:5757/demo/` in the browser
+1. Run `npm run build` to produce minified version of your library.
+
+## test
+1. Run `npm run test` to run all tests
+1. Run `npm run test:watch` to run tests in watch mode

README.md

@@ -8,7 +8,7 @@
 
 # TinyEvents
 
-TinyEvents is a tiny, framework-agnostic, event utility library for modern browsers(IE 11+). Supports jQuery like syntax. Just 1 kb gzipped.
+TinyEvents is a tiny event utility library for modern browsers(IE 11+). Supports jQuery like syntax. Just 1 kb gzipped.
 
 - Event namespace support
 - Works with collection of elements
@@ -135,7 +135,7 @@ Remove event handlers.
 
 ```js
 
-$('.btn').on('click.bg hover.bg', () => {
+tinyEvents('.btn').on('click.bg hover.bg', () => {
     document.body.style.backgroundColor = 'red';
 });
 
@@ -150,10 +150,10 @@ tinyEvents('.btn').off('.bg');
 tinyEvents('.btn').off('click');
 
 // Another example with multiple namespaces
-$('.btn').on('click.abc', () => {
+tinyEvents('.btn').on('click.abc', () => {
     document.body.style.color = 'red';
 });
-$('.btn').on('click.xyz', () => {
+tinyEvents('.btn').on('click.xyz', () => {
     document.body.style.backgroundColor = 'yellow';
 });
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-events.js",
-  "description": "TinyEvents is a tiny, framework-agnostic, event utility library for modern browsers(IE 11+). Supports jQuery like syntax. just 1 kb gzipped.",
+  "description": "TinyEvents is a tiny event utility library for modern browsers(IE 11+). Supports jQuery like syntax. Just 1 kb gzipped.",
   "version": "0.0.1",
   "browserslist": [
     "defaults"