Skip to content

Commit 6ea4759

Browse files
committed
fix-155
Signed-off-by: Antonio Mendoza Pérez <[email protected]>
1 parent e7c68be commit 6ea4759

File tree

3 files changed

+477
-418
lines changed

3 files changed

+477
-418
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,25 @@ npm install && npm run build && npm run test
3737

3838
#### Install
3939

40-
For the latest stable version:
4140

41+
##### Version >= 4.0.0
42+
Note: Version 4.0.0 has not been released yet.
43+
```sh
44+
npm i @serverlessworkflow/sdk-typescript
45+
```
46+
47+
48+
##### Version < 4.0.0
4249
```sh
4350
npm i @severlessworkflow/sdk-typescript
4451
```
4552

53+
54+
4655
#### Create Workflow using builder API
4756

4857
```typescript
49-
import { workflowBuilder, injectstateBuilder, Specification } from '@severlessworkflow/sdk-typescript';
58+
import { workflowBuilder, injectstateBuilder, Specification } from '@serverlessworkflow/sdk-typescript';
5059

5160
const workflow: Specification.Workflow = workflowBuilder()
5261
.id("helloworld")
@@ -69,7 +78,7 @@ const workflow: Specification.Workflow = workflowBuilder()
6978
#### Create Workflow from JSON/YAML source
7079

7180
```typescript
72-
import { Specification, Workflow } from '@severlessworkflow/sdk-typescript';
81+
import { Specification, Workflow } from '@serverlessworkflow/sdk-typescript';
7382

7483
const source = `id: helloworld
7584
version: '1.0'
@@ -93,7 +102,7 @@ Where `source` can be in both JSON or YAML format.
93102
Having the following workflow instance:
94103

95104
```typescript
96-
import { workflowBuilder, injectstateBuilder, Specification } from '@severlessworkflow/sdk-typescript';
105+
import { workflowBuilder, injectstateBuilder, Specification } from '@serverlessworkflow/sdk-typescript';
97106

98107
const workflow: Specification.Workflow = workflowBuilder()
99108
.id("helloworld")
@@ -139,7 +148,7 @@ The sdk provides a way to validate if a workflow object is compliant with the se
139148
- `validate(): boolean`
140149

141150
```typescript
142-
import {WorkflowValidator, Specification} from '@severlessworkflow/sdk-typescript';
151+
import {WorkflowValidator, Specification} from '@serverlessworkflow/sdk-typescript';
143152
import {Workflow} from "./workflow";
144153

145154
const workflow = {
@@ -171,7 +180,7 @@ You can also validate parts of a workflow using `validators`:
171180

172181
```typescript
173182
import { ValidateFunction } from 'ajv';
174-
import { validators, Specification } from '@severlessworkflow/sdk-typescript';
183+
import { validators, Specification } from '@serverlessworkflow/sdk-typescript';
175184

176185
const injectionState: Specification.Injectstate = workflow.states[0];
177186
const injectionStateValidator: ValidateFunction<Specification.Injectstate> = validators.get('Injectstate');

0 commit comments

Comments
 (0)