Skip to content

Commit aef8df8

Browse files
authored
chore: readme.md.
1 parent 3738a2c commit aef8df8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fnocode-js%2Fsequential-workflow-machine%2Fbadge%3Fref%3Dmain&style=flat-square)](https://actions-badge.atrox.dev/b4rtaz/sequential-workflow-machine/goto?ref=main) [![License: MIT](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](/LICENSE) [![View this project on NPM](https://img.shields.io/npm/v/sequential-workflow-machine.svg?style=flat-square)](https://npmjs.org/package/sequential-workflow-machine)
44

5-
The powerful sequential workflow machine for frontend and backend applications. It provides a simple API for creating own step execution handlers (activities). It supports multiple types of activities. Internally is uses the [xstate](https://github.com/statelyai/xstate) library.
5+
The powerful sequential workflow machine for frontend and backend applications. It provides a simple API for creating its own step execution handlers (activities). It supports multiple types of activities. Internally it uses the [xstate](https://github.com/statelyai/xstate) library.
66

77
This machine uses the same data model as the [Sequential Workflow Designer](https://github.com/nocode-js/sequential-workflow-designer). So you can create a workflow definition in the designer and then run it by this machine easily.
88

@@ -18,9 +18,9 @@ npm i sequential-workflow-model sequential-workflow-machine
1818

1919
## 🎬 Usage
2020

21-
You can use the machine in a JavaScript or TypeScript application. We recommend to use TypeScript because a workflow uses a lot of data structures and it's hard to maintain data integrity.
21+
You can use the machine in a JavaScript or TypeScript application. We recommend using TypeScript because a workflow uses a lot of data structures and it's hard to maintain data integrity.
2222

23-
At the beginning you need to define the type of your workflow definition.
23+
At the beginning, you need to define the type of your workflow definition.
2424

2525
```ts
2626
import { Definition } from 'sequential-workflow-model';
@@ -100,7 +100,7 @@ const downloadHtmlActivity = createAtomActivity<DownloadHtmlStep, WorkflowGlobal
100100
Now we can create the activity set. The activity set is a collection of all supported activities.
101101

102102
```ts
103-
import { activitySet } from 'sequential-workflow-machine';
103+
import { createActivitySet } from 'sequential-workflow-machine';
104104

105105
const activitySet = createActivitySet<WorkflowGlobalState>([
106106
downloadHtmlActivity,

0 commit comments

Comments
 (0)