From 3b652dd322fcd4bed06a75a0d1f6728629aa97b6 Mon Sep 17 00:00:00 2001
From: Seth Wang <pkyosx@gmail.com>
Date: Tue, 17 May 2022 14:26:50 +0800
Subject: [PATCH] doc(missing): Add usage examples

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 89c8ace..0ca4e6c 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,53 @@
 # Missing #
-The simple [pre-commit][0] hook to find the missing but necessary files.
+
+A simple [pre-commit][0] hook to find missing `__init__.py` that is required for unit test cases to be discovered.
 
 ## Example ##
+
+Default setting, everything except `.git` will be scanned
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+```
+
+Exclude according to .gitignore
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+      args:
+        - --mode
+        - obey_gitignore
+```
+
+Only include git staged files
+
+```yaml
+- repo: https://github.com/hardcoretech/missing
+  rev: v0.2.5
+  hooks:
+    - id: missing-init-py
+      args:
+        - --mode
+        - staged_only
+```
+
+Exclude frontend and doc folder
+
 ```yaml
 - repo: https://github.com/hardcoretech/missing
   rev: v0.2.5
   hooks:
     - id: missing-init-py
+      args:
+        - --exclude
+        - frontend
+        - doc
 ```
 
 [0]: https://pre-commit.com/