From 3dee7b89d21335d750d7504e87f22379cb93d798 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Tue, 13 Oct 2015 21:31:02 +1100 Subject: [PATCH] Updated README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bc613e43746..a8b73894a14 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # yaml -yaml is portable command line tool written in go +yaml is a lightweight and flexible command-line YAML processor -Allows you to read and update yaml files from bash (or whatever). All in a lovely dependency free binary! +The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files. -[Download latest release](https://github.com/mikefarah/yaml/releases/latest) +## Features +- Written in portable go, so you can download a lovely dependency free binary +- Deep read a yaml file with a given path +- Update a yaml file given a path +- Update a yaml file given a script file +- Convert from json to yaml +- Convert from yaml to json -or alternatively install using go get: +[Download latest binary](https://github.com/mikefarah/yaml/releases/latest) or alternatively: ``` go get github.com/mikefarah/yaml ``` @@ -160,6 +166,10 @@ b: - name: Howdy Partner ``` -## Convert to json +## Converting to and from json + +### Yaml2json To convert output to json, use the --tojson (or -j) flag. This can be used with any command. +### json2yaml +To read in json, use the --fromjson (or -J) flag. This can be used with any command.