docs(readme): move advanced features to docs site #551
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
JaKXz
commented
Apr 7, 2017
| @@ -354,7 +315,7 @@ integrated with coveralls and travis-ci.org: | |||
| ```json | |||
| { | |||
| "script": { | |||
| "test": "nyc tap ./test/*.js", | |||
| "test": "nyc mocha", | |||
There was a problem hiding this comment.
I made this change because tap uses nyc under the hood for coverage, so it doesn't make sense to go this way. Most of our tutorials use mocha so I thought I'd just continue that trend.
| "report-dir": "./alternative" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **.nycrc:** |
There was a problem hiding this comment.
Removed this section on the .nycrc example because it might cause confusion with the package.json example right above it. I'm hoping that the explanation above that the configuration can be set in either the package.json or .nycrc file is enough explanation.
README.md
Outdated
| @@ -337,6 +294,10 @@ You can specify custom high and low watermarks in nyc's configuration: | |||
| } | |||
| ``` | |||
|
|
|||
| ## Other advanced features | |||
|
|
|||
| Take a look at http://istanbul.js.org/docs/advanced/ and please feel free to contribute documentation. | |||
There was a problem hiding this comment.
Definitely open to improving this copy.
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.
Depends on istanbuljs/istanbuljs.github.io#37
I did this for the sake of paring down the README to a simpler quick start because I'm finding myself answering the same questions in our issues multiple times. This is just a step towards that end, and a further iteration will see the README better organized somehow [very open to suggestions on this].