5.1.7: README.md: disclaimer about .npmignore. fixes #61

kaelzhang · May 30, 2020 · 8374a31 · 8374a31
1 parent 55ecc53
commit 8374a31
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,11 @@
 
 `ignore` is used by eslint, gitbook and [many others](https://www.npmjs.com/browse/depended/ignore).
 
-Pay attention that [`minimatch`](https://www.npmjs.org/package/minimatch) does not work in the gitignore way. To filter filenames according to .gitignore file, I recommend this module.
+Pay **ATTENTION** that [`minimatch`](https://www.npmjs.org/package/minimatch) (which used by `fstream-ignore`) does not follow the gitignore spec.
+
+To filter filenames according to a .gitignore file, I recommend this npm package, `ignore`.
+
+To parse an `.npmignore` file, you should use `minimatch`, because an `.npmignore` file does not work in the .gitignore way.
 
 ### Tested on
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ignore",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "description": "Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others.",
   "files": [
     "legacy.js",