Skip to content

Commit 423225a

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

File tree

3 files changed

+554
-422
lines changed

3 files changed

+554
-422
lines changed

README.md

+27-10
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")
@@ -118,15 +127,23 @@ You can convert it to its string representation in JSON or YAML format
118127
by using the static methods `Workflow.toJson` or `Workflow.toYaml` respectively:
119128

120129
```typescript
121-
import { Workflow } from '../src/lib/definitions/workflow';
130+
import {Specification, workflowBuilder} from "@severlessworkflow/sdk-typescript";
131+
132+
const workflow: Specification.Workflow = workflowBuilder()
133+
//...
134+
.build()
122135

123-
const workflowAsJson: string = Workflow.toJson(workflow);
136+
const workflowAsJson: string = Specification.Workflow.toJson(workflow);
124137
```
125138

126139
```typescript
127-
import { Workflow } from '../src/lib/definitions/workflow';
140+
import {Specification, workflowBuilder} from "@severlessworkflow/sdk-typescript";
141+
142+
const workflow: Specification.Workflow = workflowBuilder()
143+
//...
144+
.build()
128145

129-
const workflowAsYaml: string = Workflow.toYaml(workflow);
146+
const workflowAsYaml: string = Specification.Workflow.toYaml(workflow);
130147
```
131148

132149

@@ -139,7 +156,7 @@ The sdk provides a way to validate if a workflow object is compliant with the se
139156
- `validate(): boolean`
140157

141158
```typescript
142-
import {WorkflowValidator, Specification} from '@severlessworkflow/sdk-typescript';
159+
import {WorkflowValidator, Specification} from '@serverlessworkflow/sdk-typescript';
143160
import {Workflow} from "./workflow";
144161

145162
const workflow = {
@@ -171,7 +188,7 @@ You can also validate parts of a workflow using `validators`:
171188

172189
```typescript
173190
import { ValidateFunction } from 'ajv';
174-
import { validators, Specification } from '@severlessworkflow/sdk-typescript';
191+
import { validators, Specification } from '@serverlessworkflow/sdk-typescript';
175192

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

0 commit comments

Comments
 (0)