docs: add basic usage

matty-rose · Oct 25, 2021 · 81cf805 · 81cf805
1 parent 3995679
commit 81cf805
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,16 @@ Go `1.17+` is required.
 go install github.com/matty-rose/[email protected]
 ```
 
+## Usage
+
+Run `gha-docs` to display general usage.
+
+### Generating a README
+While only writing to stdout is supported:
+```bash
+gha-docs generate path/to/action.yaml > README.md
+```
+
 ## License
 
 MIT License - Copyright (c) 2021