Skip to content

Commit

Permalink
fix: Update package description to correspond with repo content
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominique Wirz committed Jan 4, 2021
1 parent d0af108 commit 8af0736
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# @smartive/xstate-test-toolbox

This package contains the helper `createTestPlans` which we use for our work with xstate, @xstate/test and TestCafe.
This package contains the helper `createTestPlans` which can be used with xstate and @xstate/test.

## `createTestPlans`

This functions add the `meta`-property to every state and adds a test if it is defined within the `tests` property. (see in example) Beside that it generates all possible test plans and paths for all possible states of your guards within the machineConfig.
This function adds the `meta`-property to every state and a test if it is defined within `tests`. (see in example) Beside that it generates all possible test simple path plans for all possible combinations of your guards.

⚠️ Attention: Your statechart must consist of only string references for guards, actions and services otherwise the testing will break.
⚠️ Attention: Your statechart must consist of only string references to guards, actions and services otherwise the testing will break.

### Example

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@smartive/xstate-test-toolbox",
"version": "0.0.0-development",
"description": "Toolbox containing various helpers when working with TestCafe.",
"description": "This package contains the helper `createTestPlans` which can be used with xstate and @xstate/test.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"publishConfig": {
Expand Down

0 comments on commit 8af0736

Please sign in to comment.