#75: README.md: improves explanation of options.allowRelativePaths

kaelzhang · Dec 19, 2021 · 950d665 · 950d665
1 parent 052a722
commit 950d665
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -330,9 +330,9 @@ Which is alternative to `options.ignoreCase`
 
 ### `options.allowRelativePaths?: boolean` since 5.2.0
 
-This option brings backward compatibility with projects which based on `ignore@4.x`
+This option brings backward compatibility with projects which based on `ignore@4.x`. If `options.allowRelativePaths` is `true`, `ignore` will not check whether the given path to be tested is [`path.relative()`d](#pathname-conventions).
 
-However, passing a relative path to test if it is ignored or not is not a good practise, which might lead to unexpected behavior
+However, passing a relative path, such as `'./foo'` or `'../foo'`, to test if it is ignored or not is not a good practise, which might lead to unexpected behavior
 
 ```js
 ignore({