Skip to content

Commit

Permalink
Update readme to document ready event config
Browse files Browse the repository at this point in the history
  • Loading branch information
NeonDaniel committed Sep 17, 2024
1 parent 9f20466 commit 927b582
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,10 @@ The following top-level sections can be added to intent test configuration:
to expected: `callback_data` (list keys or dict data), `min_confidence`, and
`max_confidence`
- `common play`: TBD

- `ready event`: Optional event name to wait for before starting tests. For example,
a skill may set `_update_event` after doing some long-running process at initialization;
configuring `ready event: _update_event` means intent tests will not start until
the skill has updated and is ready to handle inputs.
## Advanced Usage
In addition to convenient CLI methods, this package also provides test cases that
may be extended.
Expand Down

0 comments on commit 927b582

Please sign in to comment.