Skip to content

Commit 464b850

Browse files
committed
Add badge and pin v1 in README.md
1 parent 8f5a255 commit 464b850

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# sphinx-lint-problem-matcher
22

3+
[![Test workflow status badge](https://github.com/rffontenelle/sphinx-lint-problem-matcher/actions/workflows/test.yml/badge.svg)](https://github.com/rffontenelle/sphinx-lint-problem-matcher/actions/workflows/test.yml)
4+
35
This action adds a GitHub Action problem matcher that annotates messages
46
printed by [sphinx-lint][sphinx-lint], making it easier to spot Sphinx
57
syntax errors.
@@ -13,7 +15,7 @@ How it shows up in the summary page of a GitHub Action run:
1315
Set to use this workflow before running `sphinx-lint`. For instance:
1416

1517
```yaml
16-
- uses: rffontenelle/sphinx-lint-problem-matcher@master
18+
- uses: rffontenelle/sphinx-lint-problem-matcher@v1
1719
- run: sphinx-lint docs/*.rst
1820
```
1921

0 commit comments

Comments
 (0)