From 72e446031e59e7a3864ab111ff11e3f3cb5d55d3 Mon Sep 17 00:00:00 2001
From: Michael Howitz <m.howitz@minddistrict.com>
Date: Wed, 14 Feb 2024 14:41:31 +0100
Subject: [PATCH] Describe options.

---
 README.rst | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 55400f1..e8afddd 100644
--- a/README.rst
+++ b/README.rst
@@ -1,9 +1,35 @@
 pre-commit-check-chameleon
 ==========================
 
-Purpose: Check for syntax and accessibility misuse in Chameleon templates.
+Purpose
+-------
 
-Usage in ``.pre-commit-config.yaml``:
+Check for syntax and accessibility misuse in Chameleon templates.
+
+
+
+Usage
+-----
+
+In ``.pre-commit-config.yaml`` add:
+
+.. code:: yaml
+
+    - repo: https://github.com/minddistrict/pre-commit-check-chameleon
+      rev: 1.0
+      hooks:
+      - id: check-chameleon
+
+Options
+-------
+
+a11y-lint-exclude
++++++++++++++++++
+
+Exclude files in the given path from the accessibility checks, so they just get
+checked for correct XML syntax.
+
+Example:
 
 .. code:: yaml
 
@@ -11,3 +37,4 @@ Usage in ``.pre-commit-config.yaml``:
       rev: 1.0
       hooks:
       - id: check-chameleon
+        args: [--a11y-lint-exclude=src/module_a/module_b/templates]