Skip to content

Commit bb823f1

Browse files
committed
Add usage information
1 parent f1b9a7c commit bb823f1

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
11
# SRComp Validate Action
22

33
A GitHub Action to validate a compstate.
4+
5+
## Usage
6+
7+
This action aims to be a fully self-contained validator for Compstate repos. Usage is therefore very simple:
8+
9+
``` yaml
10+
name: Validate
11+
12+
on:
13+
push:
14+
branches:
15+
- master
16+
pull_request:
17+
18+
jobs:
19+
validate:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v2
23+
- uses: PeterJCLaw/[email protected]
24+
```

0 commit comments

Comments
 (0)