Skip to content

Commit ec4cd1c

Browse files
committed
Update Readme
1 parent a7a5767 commit ec4cd1c

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,28 @@ This serverless plugin is a wrapper for [amplify-appsync-simulator](amplify-apps
77
- [serverless-offline](https://github.com/dherault/serverless-offline)
88
- [serverless-dynamodb-local](https://github.com/99xt/serverless-dynamodb-local) (when using dynamodb resolvers only)
99

10+
# Install
11+
12+
````bash
13+
npm install serverless-appsync-simulator
14+
# or
15+
yarn add serverless-appsync-simulator
16+
````
17+
1018
# Usage
1119

12-
This plugin relies on your serverless yml file and on the `serverless-offline` plugin*.
20+
This plugin relies on your serverless yml file and on the `serverless-offline` plugin.
1321

14-
To start it, run the followin command:
22+
````yml
23+
plugins:
24+
- serverless-dynamodb-local # only if you need dynamodb resolvers
25+
- serverless-appsync-simulator
26+
- serverless-offline
27+
````
28+
29+
**Note:** Order is important `serverless-appsync-simulator` must go **before** `serverless-offline`
30+
31+
To start the simulator, run the followin command:
1532
````bash
1633
sls offline start
1734
````
@@ -25,8 +42,6 @@ Serverless: GraphiQl: http://localhost:20002
2542
...
2643
````
2744

28-
(*): If you are using DynamoDb resolvers, you'll also need [serverless-dynamodb-local](https://github.com/99xt/serverless-dynamodb-local)
29-
3045
# Configuration
3146

3247
Put options under `custom.appsync-simulator` in your `serverless.yml` file

0 commit comments

Comments
 (0)