ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-01-26 03:04:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README with go run example (#131)

Browse Source
This commit is contained in:
Ismo Vuorinen
2026-01-01 23:47:19 +02:00
committed by GitHub
parent 6a47d067c7
commit 4a656b21ae
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -62,6 +62,32 @@ gh-action-readme gen --output-format json --output api-docs.json
gh-action-readme gen --recursive --theme professional
```
### Run Without Installing
For development or one-time usage, you can run directly with `go run`:
```bash
# Run from cloned repository
go run . gen
# Run specific commands
go run . gen --theme github
go run . validate
go run . config show
# Run with arguments
go run . gen testdata/example-action/ --output custom.md
```
Or run remotely without cloning:
```bash
# Run directly from GitHub (requires Go 1.17+)
go run github.com/ivuorinen/gh-action-readme@latest gen
go run github.com/ivuorinen/gh-action-readme@latest gen --theme professional
go run github.com/ivuorinen/gh-action-readme@latest validate
```
## 📋 Examples
### Input: `action.yml`