Merge pull request #6 from agallou/readme_template

update README using the new template

Author: Hywan

LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2010-2016, atoum contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of atoum contributors nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY ATOUM CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL ATOUM CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,9 +1,15 @@
-# atoum PHPUnit extension [![Build Status](https://travis-ci.org/atoum/phpunit-extension.svg?branch=master)](https://travis-ci.org/atoum/phpunit-extension)
+# atoum/phpunit-extension [![Build Status](https://travis-ci.org/atoum/phpunit-extension.svg?branch=master)](https://travis-ci.org/atoum/phpunit-extension)
 
-![atoum](http://downloads.atoum.org/images/logo.png)
+This extension allows you to launch your PHPUnit tests with atoum's engine.
+
+This is especially usefull when migrating to atoum.
 
 ## Install it
 
+The extension is still a work in progress. So, you need to require a developpement branch of atoum.
+
+We need your help to complete the extension, so don't hesitate to test the extension and write and issue when you found one.
+
 Install extension using [composer](https://getcomposer.org):
 
 ```json
@@ -32,6 +38,15 @@ $extension = new phpunit\extension($script);
 $extension->addToRunner($runner);
 ```
 
+## Use it
+
+You must change the parent class of your tests. For example, instead of `PHPUnit_Framework_TestCase`, extend `mageekguy\atoum\phpunit`.
+
+```diff
+-class EnumTest extends \PHPUnit_Framework_TestCase
++class EnumTest extends \mageekguy\atoum\phpunit
+```
+
 ## Support
 
 ### Helpers
@@ -166,3 +181,16 @@ $extension->addToRunner($runner);
 | `@testdox`                        | ✘         |                                                   |
 | `@ticket`                         | ✘         |                                                   |
 | `@uses`                           | ✘         |                                                   |
+
+## Links
+
+* [atoum](http://atoum.org)
+* [atoum's documentation](http://docs.atoum.org)
+* [PHPUnit](https://phpunit.de/)
+
+
+## Licence
+
+phpunit-extension is released under the BSD-3-Clause License. See the bundled LICENSE file for details.
+
+![atoum](http://atoum.org/images/logo/atoum.png)

composer.json

@@ -2,9 +2,9 @@
     "name": "atoum/phpunit-extension",
     "type": "library",
     "description": "atoum PHPUnit extension - Run your PHPUnit tests with atoum",
-    "keywords": ["TDD","atoum","test","unit testing","PHPUnit"],
+    "keywords": ["TDD", "atoum", "test", "unit testing", "PHPUnit", "atoum-extension"],
     "homepage": "http://www.atoum.org",
-    "license": "BSD",
+    "license": "BSD-3-Clause",
     "authors": [
         {
             "name": "jubianchi",