Skip to content

Commit de682e1

Browse files
author
Alice
authored
updated readme
1 parent 64b524c commit de682e1

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
2-
[![npm version](https://badge.fury.io/js/@beforeyoubid/serverless-step-functions-offline.svg)](https://badge.fury.io/js/@beforeyoubid/serverless-step-functions-offline)
32
[![Maintainability](https://api.codeclimate.com/v1/badges/b321644ef368976aee12/maintainability)](https://codeclimate.com/github/beforeyoubid/serverless-step-functions-offline/maintainability)
4-
[![NPM](https://nodei.co/npm/@beforeyoubid/serverless-step-functions-offline.png)](https://nodei.co/npm/@beforeyoubid/serverless-step-functions-offline/)
53

6-
# serverless-step-functions-offline
74

8-
![circleci status](https://circleci.com/gh/beforeyoubid/serverless-step-functions-offline.svg?style=shield)
5+
[![NPM](https://nodei.co/npm/@beforeyoubid/serverless-step-functions-offline.png)](https://nodei.co/npm/@beforeyoubid/serverless-step-functions-offline/)
6+
7+
# serverless-step-functions-offline ![circleci status](https://circleci.com/gh/beforeyoubid/serverless-step-functions-offline.svg?style=shield)
98

109
## Documentation
1110

@@ -34,7 +33,7 @@ Add the plugin to your `serverless.yml`:
3433
# serverless.yml
3534

3635
plugins:
37-
- @beforeyoubid/serverless-step-functions-offline
36+
- '@beforeyoubid/serverless-step-functions-offline'
3837
```
3938
4039
To verify that the plugin works, run this in your command line:
@@ -62,7 +61,7 @@ For example:
6261
service: ServerlessStepPlugin
6362
frameworkVersion: ">=1.13.0 <2.0.0"
6463
plugins:
65-
- @beforeyoubid/serverless-step-functions-offline
64+
- '@beforeyoubid/serverless-step-functions-offline'
6665

6766
# ...
6867

@@ -116,7 +115,7 @@ By default `process.env.STEP_IS_OFFLINE = true`.
116115
# What does plugin support?
117116
| States | Support |
118117
| ------ | ------ |
119-
| ***Task*** | At this moment plugin **does not support fields** *Retry*, *Catch*, *TimeoutSeconds*, *HeartbeatSeconds* |
118+
| ***Task*** | Supports *Retry* but at this moment **does not support fields** *Catch*, *TimeoutSeconds*, *HeartbeatSeconds* |
120119
| ***Choice*** | All comparison operators except: *And*, *Not*, *Or* |
121120
| ***Wait*** | All following fields: *Seconds*, *SecondsPath*, *Timestamp*, *TimestampPath* |
122121
| ***Parallel*** | Only *Branches* |
@@ -136,7 +135,7 @@ precedes `serverless-step-functions-offline` as the order is important:
136135
...
137136
- serverless-webpack
138137
...
139-
- serverless-step-functions-offline
138+
- '@beforeyoubid/serverless-step-functions-offline'
140139
...
141140
```
142141

@@ -146,6 +145,8 @@ precedes `serverless-step-functions-offline` as the order is important:
146145
- [x] Fixing bugs
147146
- [x] Support Pass, Fail, Succeed
148147
- [x] Integration with serverless-webpack
148+
- [x] Support Map
149+
- [x] Support field *Retry*
150+
- [ ] Support field *Catch*
149151
- [ ] Add unit tests - to make plugin stable (next step)
150-
- [ ] Support fields *Retry*, *Catch*
151152
- [ ] Support other languages except node.js

0 commit comments

Comments
 (0)