chore: add note to readme

IndigoUnited · Sep 25, 2018 · 95037f9 · 95037f9
1 parent 77cefd4
commit 95037f9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,8 @@ detectRepoLinters('./some-repository-directory')
 });
 ```
 
+Note that this package will attempt to read the `package.json` file from the specified directory and will throw a `JSONError` if a JSON parsing error occurs.
+
 At the moment the following linters are detected:
 
 - [editorconfig](http://editorconfig.org)