From 79d47ea88bae7589b3dbd1069e560a9dc2999e24 Mon Sep 17 00:00:00 2001 From: jolheiser Date: Sat, 30 Oct 2021 16:51:30 -0500 Subject: [PATCH] Add more to README Signed-off-by: jolheiser --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c58db40..8279b49 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file