📝 doc: update and re-generate README docs

gookit · Oct 13, 2023 · a279f66 · a279f66
1 parent be917ac
commit a279f66
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -86,6 +86,16 @@ i64Val = goutil.Int64("-2") // -2
 u64Val = goutil.Uint("2") // 2
 ```
 
+### Dump go variable
+
+```go
+dump.Print(somevar, somevar2, ...)
+```
+
+**dump nested struct**
+
+![preview-nested-struct](dump/_examples/preview-nested-struct.png)
+
 ## Packages
 
 ### Array and Slice
@@ -457,9 +467,10 @@ func B64DecodeBytes(str []byte) []byte
 ```go
 // source at envutil/envutil.go
 func VarReplace(s string) string
+func ParseOrErr(val string) (string, error)
+func ParseValue(val string) string
 func VarParse(val string) string
 func ParseEnvValue(val string) string
-func ParseValue(val string) (newVal string)
 func SetEnvMap(mp map[string]string)
 func SetEnvs(kvPairs ...string)
 func UnsetEnvs(keys ...string)

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -85,6 +85,16 @@ i64Val = goutil.Int64("-2") // -2
 u64Val = goutil.Uint("2") // 2
 ```
 
+### Dump go variable
+
+```go
+dump.Print(somevar, somevar2, ...)
+```
+
+**dump nested struct**
+
+![preview-nested-struct](dump/_examples/preview-nested-struct.png)
+
 ## Packages
 
 ### Array and Slice
@@ -456,9 +466,10 @@ func B64DecodeBytes(str []byte) []byte
 ```go
 // source at envutil/envutil.go
 func VarReplace(s string) string
+func ParseOrErr(val string) (string, error)
+func ParseValue(val string) string
 func VarParse(val string) string
 func ParseEnvValue(val string) string
-func ParseValue(val string) (newVal string)
 func SetEnvMap(mp map[string]string)
 func SetEnvs(kvPairs ...string)
 func UnsetEnvs(keys ...string)

diff --git a/internal/template/README.md.tpl b/internal/template/README.md.tpl
@@ -86,6 +86,16 @@ i64Val = goutil.Int64("-2") // -2
 u64Val = goutil.Uint("2") // 2
 ```
 
+### Dump go variable
+
+```go
+dump.Print(somevar, somevar2, ...)
+```
+
+**dump nested struct**
+
+![preview-nested-struct](dump/_examples/preview-nested-struct.png)
+
 ## Packages
 {{pgkFuncs}}
 ## Code Check & Testing

diff --git a/internal/template/README.zh-CN.md.tpl b/internal/template/README.zh-CN.md.tpl
@@ -85,6 +85,16 @@ i64Val = goutil.Int64("-2") // -2
 u64Val = goutil.Uint("2") // 2
 ```
 
+### Dump go variable
+
+```go
+dump.Print(somevar, somevar2, ...)
+```
+
+**dump nested struct**
+
+![preview-nested-struct](dump/_examples/preview-nested-struct.png)
+
 ## Packages
 {{pgkFuncs}}
 ## Code Check & Testing