Merge pull request #32 from agallou/improve_readme

improve documentation

Author: agallou

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 * [#30](https://github.com/agallou/phpstorm-plugin/pull/30) Easily identify test files via a custom icon ([@agallou])
 
+## Documentation
+
+* [#32](https://github.com/agallou/phpstorm-plugin/pull/32) Improve documentation ([@agallou])
+
 
 # 0.4.2 - 2016-01-20
 

README.md

@@ -1,50 +1,60 @@
 # atoum PhpStorm Plugin
 
-Integrates atoum into PhpStorm
+Integrates atoum into PhpStorm.
 
-## Features
+Features :
 
-### Go to the test class from the tested class
+* Go to the test class from the tested class
+* Go to the tested class from the test class
+* Execute tests inside PhpStorm
+* Easily identify test files by a custom icon
 
-* From the tested class you can go to the test class from a menu entry in navigation
 
-![Demo](doc/switch.png)
+## Detailed Features
 
-* Or by an entry bin the right click menu
 
-![Demo](doc/switch-right_click.png)
+### Go to the test class from the tested class
 
-* Or by clicking on the icon on the left of the class
+From the tested class you can go to the test class by clicking on the icon on the left of the class,
 
 ![Demo](doc/switch-icon.png)
 
+or from a menu entry in navigation,
 
-### Go to the tested class from the test class
+![Demo](doc/switch.png)
 
-* From the test class you can go to the tested class from a menu entry in navigation
+or by an entry bin the right click menu.
 
-![Demo](doc/switch_back-right_click.png)
+![Demo](doc/switch-right_click.png)
 
-* Or by an entry bin the right click menu
 
-![Demo](doc/switch_back-right_click.png)
+### Go to the tested class from the test class
 
-* Or by clicking on the icon on the left of the class
+From the test class you can go to the tested class by clicking on the icon on the left of the class,
 
 ![Demo](doc/switch_back-icon.png)
 
+or from a menu entry in navigation,
+
+![Demo](doc/switch_back.png)
+
+or by an entry bin the right click menu.
+
+![Demo](doc/switch_back-right_click.png)
 
-### Execute test inside PhpStorm
 
-* By an entry on the run menu and on the right click menu
+### Execute tests inside PhpStorm
+
+By an entry on the run menu and on the right click menu.
 
 ![Demo](doc/run.png)
 
-* You can run the tests from both the test file or the tested classe's file
+You can run the tests from both the test file or the tested classe's file :
 
 ![Demo](doc/run_from_tested_class.png)
 
-### Easily identify test file by a custom icon
+
+### Easily identify test files by a custom icon
 
 Atoum's test files are displayed with a different icon, like that you will easily differentiate them from other PHP files.
 
@@ -61,12 +71,14 @@ Atoum's test files are displayed with a different icon, like that you will easil
 * Click on the `install from disk` button, then select to downloaded jar
 * Restart PhpStorm
 
+
 ## Links
 
 * [PhpStorm](https://www.jetbrains.com/phpstorm/)
 * [atoum](http://atoum.org)
 * [atoum's documentation](http://docs.atoum.org)
 
+
 ## Licence
 
 atoum phpstorm-plugin is released under the MIT License. See the bundled LICENSE file for details.