This repository has been archived by the owner on Mar 4, 2022. It is now read-only.
Update readme, add changelog #61
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
jasonwilson
suggested changes
Feb 16, 2017
README.md
Outdated
|
|
||
| There are a couple patterns for including `nodejs-dashboard` in your code. This module isn't designed for production use and should be limited to development environments. | ||
| The dashboard agent needs to be required by your app. There are two ways to do this: | ||
|
|
||
| #### Including via code | ||
|
|
||
| From within a `dev.index.js` script or other dev entry point simply require the `nodejs-dashboard` module. |
There was a problem hiding this comment.
Not to be pedantic but can we include the sample from before?
README.md
Outdated
| -V, --version output the version number | ||
| -s, --scrollback [count] Maximum scroll history for log windows | ||
| ``` | ||
| Optionally supply a custom layout configuration (for details, see [below](#customizing-layouts)). Default: `layouts/default.js` |
There was a problem hiding this comment.
Might want to link to this file
condense other parts of readme and add TOC
|
@jasonwilson updated - ready for another review |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Updated readme:
Added a changelog