Skip to content

Commit af4a0c8

Browse files
committed
docs: proper plugin name in readme
1 parent 10d884b commit af4a0c8

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# serverless-step-functions-local
1+
# serverless-step-functions-local-docker
22
Run AWS step functions offline with Serverless!
33

4-
This is a plugin for the [Serverless Framework](https://serverless.com/). It uses [stepfunctions-localhost](https://www.npmjs.com/package/stepfunctions-localhost) to emulate step functions with AWS' provided tool for local development.
4+
This is a plugin for the [Serverless Framework](https://serverless.com/). It uses [stepfunctions-localhost](https://www.npmjs.com/package/stepfunctions-localhost) to emulate step functions with AWS' provided tool for local development. Alternatively you can run your own emulator such as [aws-stepfunctions-local](https://hub.docker.com/r/amazon/aws-stepfunctions-local) docker container.
55

66
## Requirements
77

@@ -11,7 +11,7 @@ This is a plugin for the [Serverless Framework](https://serverless.com/). It us
1111

1212
## Install
1313

14-
`npm install serverless-step-functions-local -D`
14+
`npm install serverless-step-functions-local-docker -D`
1515

1616
## Getting Started
1717

@@ -21,8 +21,7 @@ You'll need to add this plugin to your `serverless.yml`. The plugins section sh
2121
plugins:
2222
...
2323
- serverless-step-functions
24-
- serverless-step-functions-local
25-
- serverless-offline-lambda
24+
- serverless-step-functions-local-docker
2625
- serverless-offline
2726
...
2827
```
@@ -38,7 +37,7 @@ custom:
3837
3938
Although not neccessary, it's strongly recomended to add the folder with the downloaded step function executables to `.gitignore`. By default, this path is `./.step-functions-local`.
4039

41-
The plugin binds to port 8083, this cannot be changed.
40+
If you decide to start the emulator automatically through `startStepFunctionsLocalApp: true` the plugin binds to port 8083, this cannot be changed.
4241

4342
It also adds an environment variable for each created state machine that contains the ARN for it. These variables are prefixed by `OFFLINE_STEP_FUNCTIONS_ARN_`, so the ARN of a state machine named 'WaitMachine', for example could be fetched by reading `OFFLINE_STEP_FUNCTIONS_ARN_WaitMachine`.
4443

@@ -61,8 +60,7 @@ service: local-step-function
6160
6261
plugins:
6362
- serverless-step-functions
64-
- serverless-step-functions-local
65-
- serverless-offline-lambda
63+
- serverless-step-functions-local-docker
6664
- serverless-offline
6765
6866
provider:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "serverless-step-functions-local-docker",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Run AWS step functions offline with Serverless",
55
"main": "index.js",
66
"scripts": {},

0 commit comments

Comments
 (0)