Skip to content

Commit 34e0e22

Browse files
authored
Update README.md
1 parent 21f4ec1 commit 34e0e22

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1-
# gh-action-cff
2-
github action to check consistency of cff and zenodo citation metadata
1+
# cffconvert-github-action
2+
3+
GitHub action to check consistency of cff and zenodo citation metadata
4+
5+
6+
## Example usage
7+
8+
```yaml
9+
on: push
10+
11+
jobs:
12+
build:
13+
name: "cffconvert"
14+
runs-on: ubuntu-latest
15+
steps:
16+
# This step checks out a copy of your repository.
17+
- uses: actions/checkout@v2
18+
# This step references the directory that contains the action.
19+
- uses: citation-file-format/cffconvert-github-action
20+
```

0 commit comments

Comments
 (0)