jimeh/go-render
1
0
Fork 0
mirror of https://github.com/jimeh/go-render.git synced 2026-02-18 19:06:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): minor improvements to usage examples

Browse Source
This commit is contained in:
Jim Myhrberg
2024-03-25 03:20:05 +00:00
parent e88c0d5ca3
commit c0e1ba0d10
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -45,17 +45,26 @@ Basic usage to render a value to various formats into a `io.Writer`:
```go
version := &Version{Version: "1.2.1", Stable: true, Latest: false}
// Render version as plain text via fmt.Stringer interface.
err = render.Pretty(w, "text", version)
// 1.2.1 (stable: true, latest: false)
// Render version as JSON via marshaling.
err = render.Pretty(w, "json", version)
// {
// "version": "1.2.1",
// "latest": false,
// "stable": true
// }
err = render.Compact(w, "json", version)
// {"version":"1.2.1","latest":false,"stable":true}
// Render version as YAML via marshaling.
err = render.Pretty(w, "yaml", version)
// version: 1.2.1
// latest: false
// stable: true
// Render version as XML via marshaling.
err = render.Pretty(w, "xml", version)
// <version latest="false" stable="true">1.2.1</version>
```
The above assumes the following `Version` struct: