Skip to content

Commit 68f0a0f

Browse files
committed
update README using the new template
1 parent 17d426f commit 68f0a0f

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# atoum PHPUnit extension [![Build Status](https://travis-ci.org/atoum/phpunit-extension.svg?branch=master)](https://travis-ci.org/atoum/phpunit-extension)
1+
# atoum/phpunit-extension [![Build Status](https://travis-ci.org/atoum/phpunit-extension.svg?branch=master)](https://travis-ci.org/atoum/phpunit-extension)
22

3-
![atoum](http://atoum.org/images/logo/atoum.png)
3+
This extension allows you to launch your PHPUnit tests with atoum's engine.
4+
5+
This is especially usefull when migrating to atoum.
46

57
## Install it
68

9+
The extension is still a work in progress. So, you need to require a developpement branch of atoum.
10+
11+
We need your help to complete the extension, so don't hesitate to test the extension and write and issue when you found one.
12+
713
Install extension using [composer](https://getcomposer.org):
814

915
```json
@@ -32,6 +38,15 @@ $extension = new phpunit\extension($script);
3238
$extension->addToRunner($runner);
3339
```
3440

41+
## Use it
42+
43+
You must change the parent class of your tests. For example, instead of `PHPUnit_Framework_TestCase`, extend `mageekguy\atoum\phpunit`.
44+
45+
```diff
46+
-class EnumTest extends \PHPUnit_Framework_TestCase
47+
+class EnumTest extends \mageekguy\atoum\phpunit
48+
```
49+
3550
## Support
3651

3752
### Helpers
@@ -167,6 +182,15 @@ $extension->addToRunner($runner);
167182
| `@ticket` || |
168183
| `@uses` || |
169184

185+
## Links
186+
187+
* [atoum](http://atoum.org)
188+
* [atoum's documentation](http://docs.atoum.org)
189+
* [PHPUnit](https://phpunit.de/)
190+
191+
170192
## Licence
171193

172194
phpunit-extension is released under the BSD-3-Clause License. See the bundled LICENSE file for details.
195+
196+
![atoum](http://atoum.org/images/logo/atoum.png)

0 commit comments

Comments
 (0)