Skip to content

Commit d0165ff

Browse files
authored
Update README.md
1 parent 89adcec commit d0165ff

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,2 +1,26 @@
1-
# phpunit-port-canary
2-
Find tests that are making external requests
1+
# phpunit-port-canary [![Packagist](https://img.shields.io/packagist/dt/willwashburn/phpunit-port-canary.svg?style=flat-square)](https://packagist.org/packages/willwashburn/phpunit-port-canary/stats) [![Packagist](https://img.shields.io/packagist/v/willwashburn/phpunit-port-canary.svg?style=flat-square)](https://packagist.org/packages/willwashburn/phpunit-port-canary) [![MIT License](https://img.shields.io/packagist/l/willwashburn/phpunit-port-canary.svg?style=flat-square)](https://github.com/willwashburn/phpunit-port-canary/blob/master/license.txt)
2+
:bird: Find tests that are making external requests
3+
4+
## Why
5+
Not all tests are written perfectly. This library intends to help you spot when your phpunit tests are making requests across ports when you don't want them to.
6+
7+
>Note: This is in a super alpha bootleg version. Try it out, but.. uh, no promises.
8+
9+
## Installation
10+
11+
```
12+
composer require willwashburn/phpunit-port-canary
13+
```
14+
15+
Alternatively, add "willwashburn/phpunit-port-canary": "0.0.1" to your composer.json
16+
17+
## Configuration
18+
Add this to your phpunit.xml and any test that crosses a port should throw an error, very abrubtly.
19+
```XML
20+
<listeners>
21+
<listener class="\WillWashburn\PortListener"/>
22+
</listeners>
23+
```
24+
25+
## Change Log
26+
- v0.0.1 - MVP bootleg version

0 commit comments

Comments
 (0)