From de089481bd65b71b4d02e34ffb3566b6d189333e Mon Sep 17 00:00:00 2001
From: Peter Newman <peternewman@users.noreply.github.com>
Date: Tue, 27 Apr 2021 16:01:06 +0100
Subject: [PATCH] Update README (#30)

* Update README

Add more parameters already in actions.yml

* Add note about case sensitivity of words to actions.yml

* Switch to a deliberate typo we're already using

* Check our README separately ignoring the two intentional typos

* Self censor ourselves!
---
 .github/workflows/testing.yml |  9 ++++++++-
 README.md                     | 38 +++++++++++++++++++++++++++++++++++
 action.yml                    |  4 ++--
 3 files changed, 48 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
index 34c4219..06d8410 100644
--- a/.github/workflows/testing.yml
+++ b/.github/workflows/testing.yml
@@ -59,7 +59,14 @@ jobs:
         check_filenames: true
         check_hidden: true
         # When using this Action in other repos, the --skip option below can be removed
-        skip: ./.git,./codespell-problem-matcher/test,./test
+        skip: ./.git,./codespell-problem-matcher/test,./test,./README.md,./.github/workflows/testing.yml
+    # Check our README (and this workflow) ignoring the two intentional typos
+    - uses: ./
+      with:
+        check_filenames: true
+        check_hidden: true
+        path: ./README.md,./.github/workflows/testing.yml
+        ignore_words_list: abandonned,ackward
 
   diagnose_bats:
     name: Diagnose bats
diff --git a/README.md b/README.md
index 86ec47a..898039b 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,44 @@ with:
   skip: foo,bar
 ```
 
+### Parameter: builtin
+
+Comma-separated list of builtin dictionaries to use.
+
+This parameter is optional; by default `codespell` will use it's default selection of built in dictionaries.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  builtin: clear,rare
+```
+
+### Parameter: ignore_words_file
+
+File that contains words which will be ignored by `codespell`. File must contain one word per line.
+Words are case sensitive based on how they are written in the dictionary file.
+
+This parameter is optional; by default `codespell` will check all words for typos.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  ignore_words_file: .codespellignore
+```
+
+### Parameter: ignore_words_list
+
+Comma-separated list of words which will be ignored by `codespell`.
+Words are case sensitive based on how they are written in the dictionary file.
+
+This parameter is optional; by default `codespell` will check all words for typos.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  ignore_words_list: abandonned,ackward
+```
+
 ### Parameter: path
 
 Indicates the path to run `codespell` in.
diff --git a/action.yml b/action.yml
index e900b00..522d9cf 100644
--- a/action.yml
+++ b/action.yml
@@ -23,11 +23,11 @@ inputs:
     required: false
     default: ''
   ignore_words_file:
-    description: 'File with a list of words to be ignored'
+    description: 'File with a list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file'
     required: false
     default: ''
   ignore_words_list:
-    description: 'Comma-separated list of words to be ignored'
+    description: 'Comma-separated list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file'
     required: false
     default: ''
   path: