-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Matthew Rose <[email protected]>
- Loading branch information
1 parent
06b39aa
commit f35ade7
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,10 +38,16 @@ go install github.com/matty-rose/[email protected] | |
|
||
Run `gha-docs` to display general usage. | ||
|
||
To output to stdout: | ||
```bash | ||
gha-docs generate path/to/action.yaml | ||
``` | ||
|
||
### Generating a README | ||
While only writing to stdout is supported: | ||
|
||
This will overwrite any existing content in `README.md`. Support for injecting the generated documentation between markers is coming soon! | ||
```bash | ||
gha-docs generate path/to/action.yaml > README.md | ||
gha-docs generate --output-file README.md path/to/action.yaml | ||
``` | ||
|
||
## License | ||
|