new readme version

Author: RomainLanz

README.md

@@ -0,0 +1,55 @@
+# AdonisJS Framework
+
+[![Gitter](https://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square)](https://gitter.im/adonisjs/adonis-framework)
+[![Version](https://img.shields.io/npm/v/adonis-framework.svg?style=flat-square)](https://www.npmjs.com/package/adonis-framework)
+[![Build Status](https://img.shields.io/travis/adonisjs/adonis-framework.svg?style=flat-square)](https://travis-ci.org/adonisjs/adonis-framework)
+[![Coverage Status](https://img.shields.io/coveralls/adonisjs/adonis-framework/master.svg?style=flat-square)](https://coveralls.io/github/adonisjs/adonis-framework?branch=master)
+[![Downloads](https://img.shields.io/npm/dt/adonis-framework.svg?style=flat-square)](https://www.npmjs.com/package/adonis-framework)
+[![License](https://img.shields.io/npm/l/adonis-framework.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+
+> :pray: This repository contains the core of the AdonisJS framework.
+
+Adonis is a MVC framework for NodeJS built on solid foundations.
+
+It is the first NodeJS framework with support for [Dependency Injection](http://adonisjs.com/docs/2.0/dependency-injection) and has a lean [IoC Container](http://adonisjs.com/docs/2.0/ioc-container) to resolve and mock dependencies. It borrows the concept of [Service Providers](http://adonisjs.com/docs/2.0/service-providers) from the popular [PHP framework Laravel](https://laravel.com) to write scalable applications.
+
+You can learn more about AdonisJS and all of its awesomeness on http://adonisjs.com :evergreen_tree:
+
+## Table of Contents
+
+* [Team Members](#team-members)
+* [Requirements](#requirements)
+* [Getting Started](#getting-started)
+* [Contribution Guidelines](#contribution-guidelines)
+
+## <a name="team-members"></a>Team Members
+
+* Harminder Virk ([Caffiene Blogging](http://amanvirk.me/)) <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
+
+AdonisJS provide a [CLI tool](https://github.com/AdonisJs/adonis-cli) to scaffold and generate a project with all required dependencies.
+
+```bash
+$ npm install -g adonis-cli
+```
+
+```bash
+$ adonis new awesome-project
+$ cd awesome-project
+$ npm run start
+```
+
+[Official Documentation](http://adonisjs.com/docs/2.0/installation)
+
+## <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).

readme.md

@@ -1,35 +1,55 @@
-# Adonis Framework
+# AdonisJS Framework
 
+[![Gitter](https://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square)](https://gitter.im/adonisjs/adonis-framework)
+[![Version](https://img.shields.io/npm/v/adonis-framework.svg?style=flat-square)](https://www.npmjs.com/package/adonis-framework)
 [![Build Status](https://img.shields.io/travis/adonisjs/adonis-framework.svg?style=flat-square)](https://travis-ci.org/adonisjs/adonis-framework)
 [![Coverage Status](https://img.shields.io/coveralls/adonisjs/adonis-framework/master.svg?style=flat-square)](https://coveralls.io/github/adonisjs/adonis-framework?branch=master)
 [![Downloads](https://img.shields.io/npm/dt/adonis-framework.svg?style=flat-square)](https://www.npmjs.com/package/adonis-framework)
 [![License](https://img.shields.io/npm/l/adonis-framework.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-Adonis Framework is a MVC framework for NodeJs, built on solid foundations. Adonis is the first Nodejs framework with support for solid dependency injection and has a lean IOC container to resolve and mock dependencies.
+> :pray: This repository contains the core of the AdonisJS framework.
 
-You can learn more about adonis on http://adonisjs.com
+Adonis is a MVC framework for NodeJS built on solid foundations.
 
-## The MIT License
+It is the first NodeJS framework with support for [Dependency Injection](http://adonisjs.com/docs/2.0/dependency-injection) and has a lean [IoC Container](http://adonisjs.com/docs/2.0/ioc-container) to resolve and mock dependencies. It borrows the concept of [Service Providers](http://adonisjs.com/docs/2.0/service-providers) from the popular [PHP framework Laravel](https://laravel.com) to write scalable applications.
 
-COPYRIGHT (c) 2016 Harminder Virk
+You can learn more about AdonisJS and all of its awesomeness on http://adonisjs.com :evergreen_tree:
 
-MIT License
+## Table of Contents
 
-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:
+* [Team Members](#team-members)
+* [Requirements](#requirements)
+* [Getting Started](#getting-started)
+* [Contribution Guidelines](#contribution-guidelines)
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## <a name="team-members"></a>Team Members
 
-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.
+* Harminder Virk ([Caffiene Blogging](http://amanvirk.me/)) <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
+
+AdonisJS provide a [CLI tool](https://github.com/AdonisJs/adonis-cli) to scaffold and generate a project with all required dependencies.
+
+```bash
+$ npm install -g adonis-cli
+```
+
+```bash
+$ adonis new awesome-project
+$ cd awesome-project
+$ npm run start
+```
+
+[Official Documentation](http://adonisjs.com/docs/2.0/installation)
+
+## <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).