Improve documentation #18
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
kurayama
force-pushed
the
support/improve-documentation
branch
from
02bec35 to
c276f25
Compare
ruimarinho
requested changes
Mar 22, 2017
README.md
Outdated
| ## Debug | ||
|
|
||
| Enable verbose debugging by setting the DEBUG environment variable to DEBUG=process-manager. | ||
|
|
||
| ## Release | ||
|
|
||
| ```shell | ||
| $ npm version [<newversion> | major | minor | patch] -m "Release %s"` | ||
| $ npm version [<new version> | major | minor | patch] -m "Release %s"` |
README.md
Outdated
| ``` | ||
| ## Test | ||
|
|
||
| To test using a local version of `node.js`, run: | ||
| To test using a local version of `node`, run: | ||
|
|
||
| ```sh | ||
| $ yarn test |
kurayama
force-pushed
the
support/improve-documentation
branch
from
c276f25 to
e51e114
Compare
ruimarinho
approved these changes
Mar 22, 2017
Americas
reviewed
Mar 23, 2017
| @@ -13,13 +13,13 @@ graceful shutdowns. | |||
| Install the package via **yarn**: | |||
|
|
|||
| ```shell | |||
| $ yarn add '@uphold/process-manager' | |||
| ❯ yarn add '@uphold/process-manager' | |||
Americas
reviewed
Mar 23, 2017
| ``` | ||
|
|
||
| Or **npm**: | ||
|
|
||
| ```shell | ||
| $ npm install '@uphold/process-manager' --save | ||
| ❯ npm install '@uphold/process-manager' --save |
Americas
reviewed
Mar 23, 2017
| ## Debug | ||
|
|
||
| Enable verbose debugging by setting the DEBUG environment variable to DEBUG=process-manager. | ||
|
|
||
| ## Release | ||
|
|
||
| ```shell | ||
| $ npm version [<newversion> | major | minor | patch] -m "Release %s"` | ||
| ❯ npm version [<new version> | major | minor | patch] -m "Release %s"` |
Americas
reviewed
Mar 23, 2017
|
|
||
| ```sh | ||
| $ yarn test | ||
| ❯ yarn test |
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.
Adds LICENSE and fixes some inconsistencies in the documentation.