Skip to content

Commit 3809ccd

Browse files
committed
docs: update README
1 parent 19594f9 commit 3809ccd

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,35 @@
22

33
Provides helper traits for PHPUnit.
44

5+
- [TestDouble](#testdouble) ... Easy mock creation
6+
- [ReflectionHelper](#reflectionhelper) ... Easy private property/method testing
7+
8+
## Table of Contents
9+
10+
* [Installation](#installation)
11+
* [Usage](#usage)
12+
* [TestDouble](#testdouble)
13+
* [$this->getDouble()](#this-getdouble)
14+
* [$this->verifyInvoked()](#this-verifyinvoked)
15+
* [$this->verifyInvokedOnce()](#this-verifyinvokedonce)
16+
* [$this->verifyInvokedMultipleTimes()](#this-verifyinvokedmultipletimes)
17+
* [$this->verifyNeverInvoked()](#this-verifyneverinvoked)
18+
* [ReflectionHelper](#reflectionhelper)
19+
* [$this->getPrivateProperty()](#this-getprivateproperty)
20+
* [$this->setPrivateProperty()](#this-setprivateproperty)
21+
* [$this->getPrivateMethodInvoker()](#this-getprivatemethodinvoker)
22+
* [License](#license)
23+
524
## Installation
625

7-
Run
26+
Run:
827

9-
```sh
28+
```sh-session
1029
$ composer require --dev kenjis/phpunit-helper
1130
```
1231

1332
## Usage
1433

15-
- [TestDouble](#testdouble) ... Easy mock creation
16-
- [ReflectionHelper](#reflectionhelper) ... Easy private property/method testing
17-
1834
### `TestDouble`
1935

2036
This trait provides helper methods to create mock objects and to verify invocations.
@@ -131,7 +147,7 @@ $this->verifyInvoked(
131147
$loader,
132148
'view',
133149
[
134-
'shopConfirm', $this->anything(), TRUE
150+
'shopConfirm', $this->anything(), true
135151
]
136152
);
137153
```
@@ -312,3 +328,9 @@ $this->assertEquals(
312328
'return value of the privateMethod() method', $method()
313329
);
314330
~~~
331+
332+
## License
333+
334+
This package is licensed using the MIT License.
335+
336+
Please have a look at [`LICENSE`](LICENSE).

0 commit comments

Comments
 (0)