Skip to content

Commit e6a5eda

Browse files
committed
doc(readme) Add details about how to use.
1 parent 1075a88 commit e6a5eda

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,24 @@ require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'a
4242
use mageekguy\atoum\phpunit;
4343

4444
$extension = new phpunit\extension($script);
45-
4645
$extension->addToRunner($runner);
4746
```
4847

4948
## Use it
5049

51-
You must change the parent class of your tests. For example, instead of `PHPUnit\Framework\TestCase`, extend `mageekguy\atoum\phpunit`.
50+
By default, everything should work, simply run `atoum` as usual and
51+
your test suites will execute.
52+
53+
If you want to switch a test suite from PHPUnit to atoum, and get all
54+
the features from atoum, replace the parent class of your test suites
55+
from `PHPUnit\Framework\TestCase` to `mageekguy\atoum\phpunit`:
5256

5357
```diff
5458
-class EnumTest extends \PHPUnit\Framework\TestCase
5559
+class EnumTest extends \mageekguy\atoum\phpunit
5660
```
5761

58-
And from now, use atoum as usual. Enjoy!
62+
Enjoy!
5963

6064
## Support
6165

0 commit comments

Comments
 (0)