Skip to content

Commit ed22f92

Browse files
committed
Add README for documentation of the extension
1 parent c606d4f commit ed22f92

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Behat Speedtrap
2+
3+
[![Build Status](https://travis-ci.org/Brunty/behat-speedtrap.svg?branch=master)](https://travis-ci.org/Brunty/behat-speedtrap)
4+
5+
A smoke testing tool inspired by [symm/vape](https://github.com/symm/vape)
6+
7+
## Installation
8+
9+
Install via composer:
10+
11+
`composer require brunty/behat-speedtrap --dev`
12+
13+
## Configure
14+
15+
In your `behat.yml` file add the following extension configuration:
16+
17+
```yaml
18+
default:
19+
extensions:
20+
Brunty\Behat\SpeedtrapExtension: ~
21+
```
22+
23+
To configure the threshold for slow tests (default 2000ms) specify the configuration option:
24+
25+
```yaml
26+
default:
27+
extensions:
28+
Brunty\Behat\SpeedtrapExtension:
29+
threshold: 500 # this is in ms
30+
```
31+
32+
To configure the number of scenarios reported (default 10) specify the configuration option:
33+
34+
```yaml
35+
default:
36+
extensions:
37+
Brunty\Behat\SpeedtrapExtension:
38+
report_length: 2
39+
```
40+
41+
## Contributing
42+
43+
This started as a small personal project.
44+
45+
Although this project is small, openness and inclusivity are taken seriously. To that end a code of conduct (listed in the contributing guide) has been adopted.
46+
47+
[Contributor Guide](CONTRIBUTING.md)

0 commit comments

Comments
 (0)