Merge pull request #11 from codespell-project/peternewman-docs

Update the docs

Author: larsoner

README.md

@@ -6,7 +6,55 @@ Any warnings or errors will be annotated in the Pull Request.
 ## Usage
 
 ```
-uses: peternewman/actions-codespell@master
+uses: codespell-project/actions-codespell@master
+```
+
+### Parameter: check_filenames
+
+If set, check file names for spelling mistakes as well.
+
+This parameter is optional; by default `codespell` will only check the file contents.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  check_filenames: true
+```
+
+### Parameter: check_hidden
+
+If set, check hidden files (those starting with ".") for spelling mistakes as well.
+
+This parameter is optional; by default `codespell` will not check hidden files.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  check_hidden: true
+```
+
+### Parameter: exclude_file
+
+File with lines that should not be checked for spelling mistakes.
+
+This parameter is optional; by default `codespell` will check all lines.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  exclude_file: src/foo
+```
+
+### Parameter: skip
+
+Comma-separated list of files to skip (it accepts globs as well).
+
+This parameter is optional; by default `codespell` won't skip any files.
+
+```
+uses: codespell-project/actions-codespell@master
+with:
+  skip: foo,bar
 ```
 
 ### Parameter: path
@@ -17,7 +65,7 @@ This can be useful if your project has code you don't want to spell check for so
 This parameter is optional; by default `codespell` will run on your whole repository.
 
 ```
-uses: peternewman/actions-codespell@master
+uses: codespell-project/actions-codespell@master
 with:
   path: src
 ```
@@ -31,7 +79,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
 This parameter is optional; setting this to any value will enable it.
 
 ```
-uses: peternewman/actions-codespell@master
+uses: codespell-project/actions-codespell@master
 with:
   only_warn: 1
 ```

action.yml

@@ -11,7 +11,7 @@ inputs:
     required: false
     default: ''
   exclude_file:
-    description: 'FILE with lines that should not be changed'
+    description: 'File with lines that should not be checked for spelling mistakes'
     required: false
     default: ''
   skip: