From c0e1ba0d10a8b10a4ed47cf16780c9d2635c78cd Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Mon, 25 Mar 2024 03:20:05 +0000 Subject: [PATCH] docs(readme): minor improvements to usage examples --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae2ba16..e73c8be 100644 --- a/README.md +++ b/README.md @@ -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) +// 1.2.1 ``` The above assumes the following `Version` struct: