Update the README.md file to encourage users to use IstanbulJS. #178
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
dylans
suggested changes
Nov 27, 2018
| @@ -12,6 +12,9 @@ A package that provides the ability to remap [Istanbul](https://gotwarlost.githu | |||
|
|
|||
| `remap-istanbul` requires NodeJS 6 or later. | |||
|
|
|||
| ## Important Information | |||
| This package adds remapping functionality for the deprecated 0.x version of [Istanbul](https://github.com/gotwarlost/istanbul). The newer and actively maintained [IstanbulJS](https://github.com/istanbuljs/istanbuljs) includes remapping functionality directly, so this package is not needed for anyone working with IstanbulJS. We strongly encourage developers to leverage IstanbulJS, and only use this rempa-istanbul package when needing to support legacy versions of Istanbul. | |||
There was a problem hiding this comment.
Suggested change
| This package adds remapping functionality for the deprecated 0.x version of [Istanbul](https://github.com/gotwarlost/istanbul). The newer and actively maintained [IstanbulJS](https://github.com/istanbuljs/istanbuljs) includes remapping functionality directly, so this package is not needed for anyone working with IstanbulJS. We strongly encourage developers to leverage IstanbulJS, and only use this rempa-istanbul package when needing to support legacy versions of Istanbul. | |
| This package adds remapping functionality for the deprecated 0.x version of [Istanbul](https://github.com/gotwarlost/istanbul). The newer and actively maintained [IstanbulJS](https://github.com/istanbuljs/istanbuljs) includes remapping functionality directly, so this package (remap-istanbul) is not needed for anyone working with IstanbulJS. We strongly encourage developers to leverage IstanbulJS, and only use this package (remap-istanbul) when needing to support legacy versions of Istanbul. |
dylans
approved these changes
Nov 28, 2018
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.
No description provided.