diff --git a/README.md b/README.md index 9960e93..4729709 100644 --- a/README.md +++ b/README.md @@ -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. + ## How to get Help This is covered in depth in the [CONTRIBUTING.md](CONTRIBUTING.md#how-to-get-help) document in the repo.