From 77dda3f789c577747112edb03c3a8dde203a7fc0 Mon Sep 17 00:00:00 2001
From: Torben <59419684+entorb@users.noreply.github.com>
Date: Tue, 30 Apr 2024 05:46:07 +0200
Subject: [PATCH] Update README.md

---
 README.md | 43 ++++++++++++++++++++++++++++++++++---------
 1 file changed, 34 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 7996898..65f9642 100644
--- a/README.md
+++ b/README.md
@@ -26,15 +26,15 @@ see <https://docs.astral.sh/ruff/>
 * configures the Ruff linter and formatter hook
 * Ruff includes the features of these linters: flake8, pyupgrade and autoflake
 * Ruff includes the features of these formatters: black, isort, add-trailing-comma
-* Ruff offers a list of 700+ rules, see <https://docs.astral.sh/ruff/rules/> for list
+* Ruff offers a list of 700+ rules, see [docs.astral.sh/ruff/rules/](https://docs.astral.sh/ruff/rules/) for list
 * in my configuration I enabled most of them
 
 To disable ruff checking of a (legacy) file or path, you can
 
 * add a `# ruff: noqa` comment inside that file
-* exclude via [.ruff.toml](.ruff.toml): `extend-exclude = ["src/MyFile1.py"]`
+* exclude via [.ruff.toml](.ruff.toml) -> `extend-exclude = ["src/MyFile1.py"]`
 * exclude via [.pre-commit-config.yaml](.pre-commit-config.yaml)
-* exclude via .gitignore file
+* exclude via [.gitignore](.gitignore)
 
 To disable a certain rule for a file add
 
@@ -45,11 +45,33 @@ To disable a certain rule for a specific line of code:
 
 ## configure cspell hook (spell checker)
 
-see <https://cspell.org>
+see <https://cspell.org> and [cspell.org/configuration/document-settings/](https://cspell.org/configuration/document-settings/)
 
 * [cspell.json](cspell.json) config
 * [cspell-words.txt](cspell-words.txt) custom dictionary
 
+To disable cspell checking of a file or path, you can use
+
+* add a `# cspell: disable` comment inside that file
+* exclude via [cspell.config.yaml](cspell.config.yaml) -> ignorePaths
+* exclude via [.gitignore](.gitignore)
+
+To disable the spellchecking for a section of the file
+
+* `# cspell: disable`
+* `...`
+* `# cspell: enable`
+
+To disable a certain word for a file
+
+* `# cspell:ignore myword myyword` add to file-specifiv ignore list
+* `# cspell:words myword myyword` add to file-specifiv dictionary
+* `# cspell:disable-next-line`
+* `# cspell:ignoreRegExp g{5}|h{5}`
+
+Aliases:
+`cspell:` `cSpell:` `spell-checker:` `spellchecker:`
+
 ## run pre-commit manually
 
 `pre-commit run --all-files`
@@ -58,18 +80,21 @@ or
 
 `pre-commit run --files myFile1.py myFile2.json`
 
-## run pre-commit automated upon each `git commit` command
+## run pre-commit automatically triggered upon each `git commit` command
 
 `pre-commit install`
 
 to install the hook so it will be executed upon each local `git commit` command.
 
-## run pre-commit automated via GitHub Actions
-
-Copy dir [.github/workflows/](.github/workflows/) to your repo, to automatically trigger the run upon push of commits and creation of pull requests.
-
 ## update pre-commit hooks to latest version
 
 `pre-commit autoupdate`
 
 to update versions of all hooks in [.pre-commit-config.yaml](.pre-commit-config.yaml) to the latest version.
+
+## run pre-commit automated via GitHub Actions
+
+Copy dir [.github/workflows/](.github/workflows/) to your repo, to
+
+* automatically trigger the run upon push of commits and creation of pull requests
+* weekly autoupdate hook versions in [.pre-commit-config.yaml](.pre-commit-config.yaml)