Skip to content

Commit

Permalink
more
Browse files Browse the repository at this point in the history
  • Loading branch information
longquanzheng committed Sep 14, 2023
1 parent 3d8afac commit 8f88a9c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ Related projects:
For support or any question, please post in our [Discussion](https://github.com/indeedeng/iwf/discussions), or raise an issue.
If you are interested in helping this project, check out our [CONTRIBUTING](https://github.com/indeedeng/iwf/blob/main/CONTRIBUTING.md) page.
Below is the basic and comprehensive documentation of iWF. There are some more details in the [wiki pages](https://github.com/indeedeng/iwf/wiki).

# What is iWF

See [concepts](#basic-concepts) if you want to skip the examples.

## Example 1 : User sign-up/registry workflow
A common use case that is almost everywhere -- new user sign-up/register a new account in a website/system.
E.g. Amazon/Linkedin/Google/etc...
Expand Down Expand Up @@ -383,8 +386,8 @@ The `waitUntil` API is optional. If not defined, then the `execute` API will be

The `execute` API returns a StateDecision to decide what is next.

Both `waitUntil` and `execute` are implemented by code and executed in runtime dynamically!
So it's extremely flexible for business -- [any code change deployed will take effect immediately](https://github.com/indeedeng/iwf/wiki/How-to-modify-workflow-code-without-breaking-changes).
Both `waitUntil` and `execute` are implemented by code and executed in runtime dynamically. They are both hosted as REST API for iWF server to call.
It's extremely flexible for business -- [any code change deployed will take effect immediately](https://github.com/indeedeng/iwf/wiki/How-to-modify-workflow-code-without-breaking-changes).

### StateDecision from `execute`
User workflow implements a **`execute` API** to return a StateDecision for:
Expand Down

0 comments on commit 8f88a9c

Please sign in to comment.