From 8af0736c555f84da70e7d1efbf1a7fa6b81e4450 Mon Sep 17 00:00:00 2001 From: Dominique Wirz Date: Mon, 4 Jan 2021 09:36:14 +0100 Subject: [PATCH] fix: Update package description to correspond with repo content --- README.md | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 785a68f3..eb8500e7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 4b7de056..6ea002a7 100644 --- a/package.json +++ b/package.json @@ -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": {