Skip to content

Commit 3dee7b8

Browse files
committed
Updated README
1 parent c955815 commit 3dee7b8

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# yaml
2-
yaml is portable command line tool written in go
2+
yaml is a lightweight and flexible command-line YAML processor
33

4-
Allows you to read and update yaml files from bash (or whatever). All in a lovely dependency free binary!
4+
The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
55

6-
[Download latest release](https://github.com/mikefarah/yaml/releases/latest)
6+
## Features
7+
- Written in portable go, so you can download a lovely dependency free binary
8+
- Deep read a yaml file with a given path
9+
- Update a yaml file given a path
10+
- Update a yaml file given a script file
11+
- Convert from json to yaml
12+
- Convert from yaml to json
713

8-
or alternatively install using go get:
14+
[Download latest binary](https://github.com/mikefarah/yaml/releases/latest) or alternatively:
915
```
1016
go get github.com/mikefarah/yaml
1117
```
@@ -160,6 +166,10 @@ b:
160166
- name: Howdy Partner
161167
```
162168
163-
## Convert to json
169+
## Converting to and from json
170+
171+
### Yaml2json
164172
To convert output to json, use the --tojson (or -j) flag. This can be used with any command.
165173
174+
### json2yaml
175+
To read in json, use the --fromjson (or -J) flag. This can be used with any command.

0 commit comments

Comments
 (0)