Merge pull request #78 from bagerard/fix_precommit_hook_passfilename

Update .pre-commit-hooks.yaml

Author: Olivier Chédru

.pre-commit-hooks.yaml

@@ -5,3 +5,4 @@
   args: []
   language: python
   files: ^(.*requirements.*\.txt|setup\.cfg|setup\.py|pyproject\.toml|liccheck\.ini)$
+  pass_filenames: false

README.rst

@@ -37,6 +37,11 @@ Paranoid:
     for the package to be considered compliant. A package is still
     compliant if present in the authorized packages list.
 
+Assumption
+==========
+The tool requires to be installed in the same python (virtual) environment as the packages. This, because it uses
+``pkg_resources`` to access the packages resources and thus, their licenses information.
+
 How to install
 ==============
 
@@ -130,6 +135,19 @@ If some dependencies are unknown or are not matching the strategy, the output wi
 	      dependency:
 	          feedparser
 
+
+Using liccheck with pre-commit
+==============================
+
+Add this to your .pre-commit-config.yaml:
+::
+
+    - repo: https://github.com/dhatim/python-license-check
+      rev: master
+      hooks:
+      - id: liccheck
+        language: system
+
 Contributing
 ============