From eeaa483fa53f1e2aff0391bcd20f0423299b8c2b Mon Sep 17 00:00:00 2001 From: Andrew Mascillaro Date: Tue, 5 Apr 2022 15:05:02 -0400 Subject: [PATCH] Add Unix usage instructions to README Powershell instructions will be different, and should be added too, but this should help clarify the use case as described in #15 --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 3252456..1356791 100644 --- a/README.md +++ b/README.md @@ -60,3 +60,12 @@ Binaries for macOS, Linux, and Windows are [attached to each release](https://gi Packages contained in this repo may also be used to convert all supported data formats to a normalized tree of ordered Go objects. See [godoc](https://godoc.org/github.com/sclevine/yj) for details. + +### Usage + +`yj` operates on stdin inputs and its output can be piped into a file with the new format. +On Unix systems, the program can be used as follows: + +```bash +yj -jt < input.json > output.toml +```