Update comments

darylnwk · Mar 7, 2020 · 59bd3bc · 59bd3bc
1 parent 955f45e
commit 59bd3bc
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,14 @@
 # flatten
-Flatten Go structs with JSON tags
+--
+    import "github.com/darylnwk/flatten"
+
+
+## Usage
+
+#### func  Struct
+
+```go
+func Struct(s interface{}, m map[string]interface{})
+```
+Struct parses a struct `s` with JSON tags and flattens nested parameters to only
+one level and passes the result to `m`.
diff --git a/flatten.go b/flatten.go
@@ -6,7 +6,8 @@ import (
 	"strings"
 )
 
-// Struct flattens a struct with json tags
+// Struct parses a struct `s` with JSON tags and flattens nested parameters
+// to only one level and passes the result to `m`.
 func Struct(s interface{}, m map[string]interface{}) {
 	flatten("", s, m)
 }