Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README.md file to encourage users to use IstanbulJS. #178

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the README.md file to encourage users to use IstanbulJS. #178

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## How to get Help

This is covered in depth in the [CONTRIBUTING.md](CONTRIBUTING.md#how-to-get-help) document in the repo.
Expand Down