Skip to content

Commit

Permalink
docs: update usage for output file
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Rose <[email protected]>
  • Loading branch information
matty-rose committed Oct 25, 2021
1 parent 06b39aa commit f35ade7
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f35ade7

Please sign in to comment.