From 1c14cff57e1cb5aaeb96d35ff761af3e3fc29ffe Mon Sep 17 00:00:00 2001
From: Chi-Sheng Liu <chi-sheng.liu@gofreight.com>
Date: Wed, 25 Oct 2023 17:22:25 +0800
Subject: [PATCH] docs(readme): Update README.md

[FIS-1417]
[FIS-1418]
---
 README.md | 38 +++++++-------------------------------
 1 file changed, 7 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 0ca4e6c..dcdb6a1 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,23 @@
-# Missing #
+# Missing
 
-A simple [pre-commit][0] hook to find missing `__init__.py` that is required for unit test cases to be discovered.
+A simple [pre-commit][0] hook to find missing `__init__.py`. Will obey settings in `.gitignore`.
 
-## Example ##
+## Example
 
-Default setting, everything except `.git` will be scanned
+Default settings
 
 ```yaml
 - repo: https://github.com/hardcoretech/missing
-  rev: v0.2.5
+  rev: v0.3.0
   hooks:
     - id: missing-init-py
 ```
 
-Exclude according to .gitignore
+Exclude some folders
 
 ```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
+  rev: v0.3.0
   hooks:
     - id: missing-init-py
       args: