Skip to content

Commit 05ba0ac

Browse files
committed
Add list of use cases
1 parent d5d965f commit 05ba0ac

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This package lets you run AWS Step Functions state machines completely locally,
2525
## Table of contents
2626

2727
- [Features](#features)
28+
- [Use cases](#use-cases)
2829
- [Installation](#installation)
2930
- [Importing](#importing)
3031
- [Node.js](#nodejs)
@@ -50,6 +51,16 @@ This package lets you run AWS Step Functions state machines completely locally,
5051

5152
To see the list of features defined in the specification that have full support, partial support, or no support, refer to [this document](/docs/feature-support.md).
5253

54+
## Use cases
55+
56+
Why would you want to use this package? Below is a non-exhaustive list of use cases for `aws-local-stepfunctions`:
57+
58+
- Testing state machines changes locally before deploying them to AWS.
59+
- Testing the integration between a state machine and the Lambda functions associated with it in `Task` states.
60+
- Debugging the code of associated Lambda functions interactively using the [`Task` state resource override feature](/docs/feature-support.md#task-state-resource-override).
61+
- Debugging a state machine by using the [event logs feature](/docs/feature-support.md#execution-event-logs), to better understand the transitions between states and how data flows between them.
62+
- Running state machines in the browser (not possible with [AWS Step Functions Local](https://docs.aws.amazon.com/step-functions/latest/dg/sfn-local.html)).
63+
5364
## Installation
5465

5566
```sh

0 commit comments

Comments
 (0)