Skip to content

Commit 41170f1

Browse files
Use v2 in README (#69)
It looks like v2 is already released, so README should point it instead of v1.
1 parent 94259cd commit 41170f1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Any warnings or errors will be annotated in the Pull Request.
66
## Usage
77

88
```yml
9-
uses: codespell-project/actions-codespell@v1
9+
uses: codespell-project/actions-codespell@v2
1010
```
1111
1212
### Parameter: check_filenames
@@ -16,7 +16,7 @@ If set, check file names for spelling mistakes as well.
1616
This parameter is optional; by default `codespell` will only check the file contents.
1717

1818
```yml
19-
uses: codespell-project/actions-codespell@v1
19+
uses: codespell-project/actions-codespell@v2
2020
with:
2121
check_filenames: true
2222
```
@@ -28,7 +28,7 @@ If set, check hidden files (those starting with ".") for spelling mistakes as we
2828
This parameter is optional; by default `codespell` will not check hidden files.
2929

3030
```yml
31-
uses: codespell-project/actions-codespell@v1
31+
uses: codespell-project/actions-codespell@v2
3232
with:
3333
check_hidden: true
3434
```
@@ -40,7 +40,7 @@ File with lines that should not be checked for spelling mistakes.
4040
This parameter is optional; by default `codespell` will check all lines.
4141

4242
```yml
43-
uses: codespell-project/actions-codespell@v1
43+
uses: codespell-project/actions-codespell@v2
4444
with:
4545
exclude_file: src/foo
4646
```
@@ -52,7 +52,7 @@ Comma-separated list of files to skip (it accepts globs as well).
5252
This parameter is optional; by default `codespell` won't skip any files.
5353

5454
```yml
55-
uses: codespell-project/actions-codespell@v1
55+
uses: codespell-project/actions-codespell@v2
5656
with:
5757
skip: foo,bar
5858
```
@@ -64,7 +64,7 @@ Comma-separated list of builtin dictionaries to use.
6464
This parameter is optional; by default `codespell` will use its default selection of built in dictionaries.
6565

6666
```yml
67-
uses: codespell-project/actions-codespell@v1
67+
uses: codespell-project/actions-codespell@v2
6868
with:
6969
builtin: clear,rare
7070
```
@@ -77,7 +77,7 @@ Words are case sensitive based on how they are written in the dictionary file.
7777
This parameter is optional; by default `codespell` will check all words for typos.
7878

7979
```yml
80-
uses: codespell-project/actions-codespell@v1
80+
uses: codespell-project/actions-codespell@v2
8181
with:
8282
ignore_words_file: .codespellignore
8383
```
@@ -90,7 +90,7 @@ Words are case sensitive based on how they are written in the dictionary file.
9090
This parameter is optional; by default `codespell` will check all words for typos.
9191

9292
```yml
93-
uses: codespell-project/actions-codespell@v1
93+
uses: codespell-project/actions-codespell@v2
9494
with:
9595
ignore_words_list: abandonned,ackward
9696
```
@@ -104,7 +104,7 @@ If set to "*", all misspelling in URIs and emails will be ignored.
104104
This parameter is optional; by default `codespell` will check all URIs and emails for typos.
105105

106106
```yml
107-
uses: codespell-project/actions-codespell@v1
107+
uses: codespell-project/actions-codespell@v2
108108
with:
109109
uri_ignore_words_list: abandonned
110110
```
@@ -117,7 +117,7 @@ This can be useful if your project has code you don't want to spell check for so
117117
This parameter is optional; by default `codespell` will run on your whole repository.
118118

119119
```yml
120-
uses: codespell-project/actions-codespell@v1
120+
uses: codespell-project/actions-codespell@v2
121121
with:
122122
path: src
123123
```
@@ -131,7 +131,7 @@ All errors and warnings are annotated in Pull Requests, but it will act like eve
131131
This parameter is optional; setting this to any value will enable it.
132132

133133
```yml
134-
uses: codespell-project/actions-codespell@v1
134+
uses: codespell-project/actions-codespell@v2
135135
with:
136136
only_warn: 1
137137
```

0 commit comments

Comments
 (0)