From e4bb0a903ff5db9f94c217a2dc0d381b2e1781a1 Mon Sep 17 00:00:00 2001 From: Matthew Rose Date: Sat, 27 Nov 2021 15:04:21 +1000 Subject: [PATCH] docs: update readme with version bump Signed-off-by: Matthew Rose --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b490845..27f2dd8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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