Skip to content

improve readme from source example #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 6, 2021
Merged

improve readme from source example #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
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