[WIP] Rewrite docs to include examples #115
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
timneutkens
changed the title
leo
suggested changes
Jan 2, 2017
README.md
Outdated
|
|
||
| ## Example | ||
| ## How to use |
README.md
Outdated
| send(res, 200, 'Ready!') | ||
| } | ||
| ``` | ||
| npm install micro --save |
There was a problem hiding this comment.
Command line indicator (dollar sign) missing. Also please put the flag before the package name!
README.md
Outdated
| ``` | ||
|
|
||
| To run the microservice on port `3000`, use the `micro` command: | ||
| Add a script to your package.json like this: |
# Conflicts: # README.md
This reverts commit dff3225.
|
Oh wow, thanks for this PR! I learned a lot by looking at the revised README. |
onbjerg
reviewed
Jan 20, 2017
README.md
Outdated
|
|
||
| ```bash | ||
| micro -H localhost sleep.js | ||
| { |
There was a problem hiding this comment.
Missing opening code fence (```)
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| #### Api |
There was a problem hiding this comment.
API (it's an abbreviation)
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| #### Api |
There was a problem hiding this comment.
API (it's an abbreviation)
README.md
Outdated
|
|
||
| **`createError(code, msg, orig)`** | ||
| #### Api |
There was a problem hiding this comment.
API (it's an abbreviation)
README.md
Outdated
| @@ -249,6 +238,24 @@ function handleErrors (fn) { | |||
| } | |||
| ``` | |||
|
|
|||
| #### Api | |||
There was a problem hiding this comment.
API (it's an abbreviation)
|
Added some comments, hope you don't mind 😊 |
|
I wonder if we should disable |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
I rewrote / moved a lot of stuff around. Please have a look :) Will add the examples soon.