Skip to content

Commit

Permalink
doc(readme) Add details about how to use.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hywan committed Oct 4, 2017
1 parent 1075a88 commit e6a5eda
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,24 @@ require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'a
use mageekguy\atoum\phpunit;

$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`.
By default, everything should work, simply run `atoum` as usual and
your test suites will execute.

If you want to switch a test suite from PHPUnit to atoum, and get all
the features from atoum, replace the parent class of your test suites
from `PHPUnit\Framework\TestCase` to `mageekguy\atoum\phpunit`:

```diff
-class EnumTest extends \PHPUnit\Framework\TestCase
+class EnumTest extends \mageekguy\atoum\phpunit
```

And from now, use atoum as usual. Enjoy!
Enjoy!

## Support

Expand Down

0 comments on commit e6a5eda

Please sign in to comment.