From da2620a37f93557b9c8bb3fd9fa705494195a5d2 Mon Sep 17 00:00:00 2001
From: jolheiser <john.olheiser@gmail.com>
Date: Sun, 31 Oct 2021 16:04:40 -0500
Subject: [PATCH] Remove From

Signed-off-by: jolheiser <john.olheiser@gmail.com>
---
 README.md                 | 33 +++++++++++++++++++++++++++++++++
 examples/flagset/main.go  |  2 +-
 examples/multiple/main.go |  2 +-
 examples/single/main.go   |  2 +-
 ffmd.go                   |  8 ++++----
 5 files changed, 40 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 8279b49..c0a0e20 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,39 @@ With `ffmd` you can generate markdown docs for both `flag.FlagSet` and `ffcli.Co
 
 Check out [examples](examples) for some sample generated docs.
 
+## Generate your docs
+
+```go
+//go:build generate
+// +build generate
+
+package main
+
+import (
+	"os"
+	
+	"go.jolheiser.com/ffmd"
+)
+
+func main() {
+	fi, err := os.Create("docs.md")
+	if err != nil {
+		panic(err)
+    }
+	defer fi.Close()
+
+	// cmd is the ffcli.Command 
+	md, err := ffmd.Command(cmd)
+	if err != nil {
+		panic(err)
+    }
+	
+	if _, err := fi.WriteString(md); err != nil {
+		panic(err)
+    }
+}
+
+```
 
 ## License
 
diff --git a/examples/flagset/main.go b/examples/flagset/main.go
index 324d763..594c0ea 100644
--- a/examples/flagset/main.go
+++ b/examples/flagset/main.go
@@ -23,7 +23,7 @@ func main() {
 	fs.Duration("duration-flag", 0, "Duration flag with no default")
 	fs.Duration("duration-flag-default", time.Minute*5, "Duration flag with default")
 
-	md, err := ffmd.FromFlagSet(fs)
+	md, err := ffmd.FlagSet(fs)
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/multiple/main.go b/examples/multiple/main.go
index 049a5bc..4baf58e 100644
--- a/examples/multiple/main.go
+++ b/examples/multiple/main.go
@@ -62,7 +62,7 @@ func main() {
 	cmd2.Subcommands = []*ffcli.Command{cmd3, cmd5}
 	cmd3.Subcommands = []*ffcli.Command{cmd4}
 
-	md, err := ffmd.FromCommand(cmd)
+	md, err := ffmd.Command(cmd)
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/single/main.go b/examples/single/main.go
index c13a81a..8373c4f 100644
--- a/examples/single/main.go
+++ b/examples/single/main.go
@@ -31,7 +31,7 @@ func main() {
 		Subcommands: nil,
 	}
 
-	md, err := ffmd.FromCommand(cmd)
+	md, err := ffmd.Command(cmd)
 	if err != nil {
 		panic(err)
 	}
diff --git a/ffmd.go b/ffmd.go
index eaf7da3..1b7d0a7 100644
--- a/ffmd.go
+++ b/ffmd.go
@@ -19,13 +19,13 @@ var (
 	Template = template.Must(template.New("").Parse(ffmdtmpl))
 )
 
-// FromCommand turns a ffcli.Command into markdown
-func FromCommand(cmd *ffcli.Command) (string, error) {
+// Command turns a ffcli.Command into markdown
+func Command(cmd *ffcli.Command) (string, error) {
 	return fromCommand(cmd, 1)
 }
 
-// FromFlagSet turns a flag.FlagSet into markdown
-func FromFlagSet(fs *flag.FlagSet) (string, error) {
+// FlagSet turns a flag.FlagSet into markdown
+func FlagSet(fs *flag.FlagSet) (string, error) {
 	return flagSetCommand(fs, 2).Markdown()
 }