Skip to content

Commit 412877e

Browse files
authored
Hotfix: Fix documentation
1 parent 1ac79db commit 412877e

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ WIP mode. Yet works for a few months in our company (doesn't mean it's stable).
77

88
## Usage
99

10-
Paws looks for config at `./paws.yml` path by default, but path to config can be specified after run command.
10+
Paws looks for config at `${PAWS_HOME}/paws.yml` path by default, but path to config can be specified after run command.
11+
12+
By default `PAWS_HOME=~/.kittypaws`.
1113

1214
Using cargo:
1315
```bash
@@ -107,6 +109,26 @@ plugins:
107109
config02: 44
108110
...
109111
```
112+
113+
### Run duration
114+
115+
You can specify if the test run should stop after some time. To configure it, add
116+
117+
```yaml
118+
duration: <Duration in ISO 8601 format>
119+
```
120+
121+
to the root of the config.
122+
123+
Example:
124+
125+
```yaml
126+
duration: P1D
127+
plugins:
128+
- name: example
129+
...
130+
```
131+
110132
### Startup configuration
111133
112134
Plugins can start executing their tasks immediately, or after some time. You can configure them to wait for their interval first or wait for a specific delay and then continue to work normally.

0 commit comments

Comments
 (0)