📝 docs: Remove wrong docs link for this hook, add Usage section

README.md

@@ -1,6 +1,15 @@
 # typos-pre-commit-mirror
 
-Support `pre-commit <= 3.2.0`.<br>
+Mirror of the `typos` pre-commit hook for `pre-commit`. Supports `pre-commit` versions 2.9.2 and later.
 
-For example `pre-commit` configs, please see the [pre-commit.md](https://github.com/crate-ci/typos/blob/master/docs/pre-commit.md)
+## Usage
 
+Add this to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/PFCCLab/typos-pre-commit-mirror.git
+  rev: v1.29.4
+  hooks:
+    - id: typos
+      args: [--force-exclude]
+```

mirror.py

@@ -22,6 +22,9 @@ def main():
     # Load pyproject.toml
     with open(Path(__file__).parent / "pyproject.toml", "rb") as f:
         pyproject = tomli.load(f)
+    # Load README.md
+    with open(Path(__file__).parent / "README.md", "r") as f:
+        readme = f.read()
 
     # 获取当前版本的 typos
     deps = pyproject["project"]["dependencies"]
@@ -48,8 +51,14 @@ def main():
         # Update pyproject.toml
         pyproject["project"]["version"] = str(version)
         pyproject["project"]["dependencies"] = [f"typos=={version}"]
+        # Update README.md
+        readme = readme.replace(str(current_version), str(version))
+
+        # Write pyproject.toml and README.md
         with open(Path(__file__).parent / "pyproject.toml", "wb") as f:
             tomli_w.dump(pyproject, f)
+        with open(Path(__file__).parent / "README.md", "w") as f:
+            f.write(readme)
 
         # Commit and tag
         subprocess.run(["git", "add", "pyproject.toml"])