jolheiser
/
ffmd
1
0
Fork 0
Code Issues Pull Requests Releases 3 Activity

Add more to README 

Signed-off-by: jolheiser <john.olheiser@gmail.com>
main
jolheiser 2021-10-30 16:51:30 -05:00
parent 2b03d73292
commit 79d47ea88b
Signed by: jolheiser
GPG Key ID: B853ADA5DA7BBF7A
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,6 +2,14 @@
[![Go Reference](https://pkg.go.dev/badge/go.jolheiser.com/ffmd.svg)](https://pkg.go.dev/go.jolheiser.com/ffmd)
One of the things that I really liked about [urfave/cli](https://github.com/urfave/cli) was that it could
generate markdown docs for my commands.
With `ffmd` you can generate markdown docs for both `flag.FlagSet` and `ffcli.Command` (with any amount of sub-commands).
Check out [examples](examples) for some sample generated docs.
## License
[MIT](LICENSE)