We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 21f4ec1 commit 34e0e22Copy full SHA for 34e0e22
1 file changed
README.md
@@ -1,2 +1,20 @@
1
-# gh-action-cff
2
-github action to check consistency of cff and zenodo citation metadata
+# cffconvert-github-action
+
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