Skip to content

Commit

Permalink
improve readme from source example
Browse files Browse the repository at this point in the history
Signed-off-by: Antonio Mendoza Pérez <[email protected]>
  • Loading branch information
antmendoza committed Jul 5, 2021
1 parent 6e6dc9d commit 5b8f3ae
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,26 @@ const workflow: Specification.Workflow = workflowBuilder()
.build();
```


#### Load a file JSON/YAML to a Workflow instance
#### Create Workflow from JSON/YAML source

```typescript
import { Specification, Workflow } from '@severlessworkflow/sdk-typescript';

const source = `id: helloworld
version: '1.0'
name: Hello World Workflow
description: Inject Hello World
start: Hello State
states:
- type: inject
name: Hello State
data:
result: Hello World!
end: true`

const workflow: Specification.Workflow = Workflow.fromSource(source);
```
Where `source` is a JSON or a YAML string.

Where `source` can be in both JSON or YAML format.

#### Parse a Workflow instance to JSON/YAML

Expand Down

0 comments on commit 5b8f3ae

Please sign in to comment.