Skip to content

Commit

Permalink
docs: update readme with version bump
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Rose <[email protected]>
  • Loading branch information
matty-rose committed Nov 27, 2021
1 parent dcaa5ad commit e4bb0a9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A program to generate documentation for GitHub [composite actions](https://docs.
Substitute `darwin` for `linux` if installing on MacOS.

```bash
export GHA_DOCS_VERSION=v0.14.0
export GHA_DOCS_VERSION=v0.15.0
export GHA_DOCS_OS=linux
export GHA_DOCS_ARCH=amd64

Expand All @@ -31,7 +31,7 @@ chmod +x gha-docs && mv gha-docs /usr/local/bin
Go `1.17+` is required.

```bash
go install github.com/matty-rose/gha-docs@v0.14.0
go install github.com/matty-rose/gha-docs@v0.15.0
```

## Usage
Expand Down Expand Up @@ -61,6 +61,10 @@ Then use the `-i/--inject` flag to inject the documentation into the file specif
gha-docs generate -i -o README.md path/to/action.yaml
```

## Future Improvements
- [ ] Add CI workflow to auto-commit find/replace version updates to README on release
- [ ] Parse config from `.gha-docs.yml`

## License

MIT License - Copyright (c) 2021

0 comments on commit e4bb0a9

Please sign in to comment.