Update docs for use with serverless-offline #144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HyperBrain
pushed a commit
that referenced
this pull request
Jul 4, 2017
HyperBrain
pushed a commit
that referenced
this pull request
Jul 4, 2017
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What did you implement:
Obsoletes #104
Added detailed documentation about how to use the plugin together with serverless-offline and moved the docs into a new section as it was done with #104. Additionally mentioned the
--locationoption and the two calling alternativesserverless offlineandserverless offline start.Moved the serve documentation near the end as we plan to remove it (see #135) and added a note about that discussion.
How did you implement it:
Modified the README.
How can we verify it:
Read the docs 😄
Todos:
[ ] Write testsFix linting errors (not yet implemented)Make sure code coverage hasn't dropped (not yet implemented)[ ] Provide verification config / commands / resources[ ] Enable "Allow edits from maintainers" for this PRIs this ready for review?: YES
Is it a breaking change?: NO