style(readme,contributing,license): Improved readme and added github necessary files

thetutlage · thetutlage · commit 119a9742ef1b · 2016-01-14T22:23:28.000+05:30
Improved readme and added Contributing and license file
diff --git a/.npmignore b/.npmignore
@@ -6,3 +6,5 @@ test
 .travis.yml
 .editorconfig
 benchmarks
+CONTRIBUTING.md
+LICENSE.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,6 @@
+# Contributing
+
+In favor of active development we accept contributions from everyone. You can contribute by submitting a bug, creating pull requests or even by improving documentation.
+
+Below is the guide to be followed strictly before submitting your pull requests.
+http://adonisjs.com/docs/2.0/contributing
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Harminder Virk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/readme.md b/readme.md
@@ -1,31 +1,43 @@
 # Adonis Commands
 
-![](https://img.shields.io/travis/adonisjs/adonis-commands.svg)
-[![Coverage Status](https://coveralls.io/repos/adonisjs/adonis-commands/badge.svg?branch=master&service=github)](https://coveralls.io/github/adonisjs/adonis-commands?branch=master)
+[![Gitter](https://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square)](https://gitter.im/adonisjs/adonis-framework)
+[![Trello](https://img.shields.io/badge/TRELLO-%E2%86%92-89609E.svg?style=flat-square)](https://trello.com/b/yzpqCgdl/adonis-for-humans)
+[![Version](https://img.shields.io/npm/v/adonis-commands.svg?style=flat-square)](https://www.npmjs.com/package/adonis-commands)
+[![Build Status](https://img.shields.io/travis/adonisjs/adonis-commands/master.svg?style=flat-square)](https://travis-ci.org/adonisjs/adonis-commands)
+[![Coverage Status](https://img.shields.io/coveralls/adonisjs/adonis-commands/master.svg?style=flat-square)](https://coveralls.io/github/adonisjs/adonis-commands?branch=master)
+[![Downloads](https://img.shields.io/npm/dt/adonis-commands.svg?style=flat-square)](https://www.npmjs.com/package/adonis-commands)
+[![License](https://img.shields.io/npm/l/adonis-framework.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-Adonis commands are official set of commands shipped with brand new installation of [Adonis Framework](http://adonisjs.com/)
+> :pray: Bunch of official ace commands shipped with Adonis framework.
 
-## The MIT License
+This repo contains commands used by [ace](http://adonisjs.com/docs/2.0/ace-commands) to do common tasks from command line. It includes
 
-COPYRIGHT (c) 2015 Harminder Virk
+1. Generators for `controllers, model, middleware and commands`.
 
-MIT License
+You can learn more about AdonisJS and all of its awesomeness on http://adonisjs.com :evergreen_tree:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+## Table of Contents
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* [Team Members](#team-members)
+* [Requirements](#requirements)
+* [Getting Started](#getting-started)
+* [Contribution Guidelines](#contribution-guidelines)
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## <a name="team-members"></a>Team Members
+
+* Harminder Virk ([Medium Blog](https://medium.com/@amanvirk)) <virk.officials@gmail.com>
+
+## <a name="requirements"></a>Requirements
+
+AdonisJS is build on the top of ES2015, which makes the code more enjoyable and cleaner to read. It doesn't make use of any transpiler and depends upon Core V8 implemented features.
+
+For these reasons, AdonisJS require you to use `node >= 4.0` and `npm >= 3.0`.
+
+## <a name="getting-started"></a>Getting Started
+
+
+## <a name="contribution-guidelines"></a>Contribution Guidelines
+
+In favor of active development we accept contributions for everyone. You can contribute by submitting a bug, creating pull requests or even improving documentation.
+
+You can find a complete guide to be followed strictly before submitting your pull requests in the [Official Documentation](http://adonisjs.com/docs/2.0/contributing).
