Skip to content

Commit

Permalink
update readme (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
kaibocai authored Jan 8, 2024
1 parent fa3aaea commit bb60e4e
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Orchestrations can start child orchestrations using the `call_sub_orchestrator`

Orchestrations can wait for external events using the `wait_for_external_event` API. External events are useful for implementing human interaction patterns, such as waiting for a user to approve an order before continuing.

### Continue-as-new (TODO)
### Continue-as-new

Orchestrations can be continued as new using the `continue_as_new` API. This API allows an orchestration to restart itself from scratch, optionally with a new input.

Expand Down Expand Up @@ -179,18 +179,14 @@ npm run test:unit

### Running E2E tests

The E2E (end-to-end) tests require a sidecar process to be running. You can use the Dapr sidecar for this or run a Durable Task test sidecar using the following `docker` command:

```sh
docker run --name durabletask-sidecar -p 4001:4001 --env 'DURABLETASK_SIDECAR_LOGLEVEL=Debug' --rm cgillum/durabletask-sidecar:latest start --backend Emulator
```

To run the E2E tests, run the following command from the project root:

```sh
npm run test:e2e
```

This command will start a durabletask sidecar docker container (cgillum/durabletask-sidecar:latest).

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down

0 comments on commit bb60e4e

Please sign in to comment.