From bcf2ee8bcc47e5fdf5e6ecfeb9482f698bd19333 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Sun, 27 Sep 2015 13:29:20 +1000 Subject: [PATCH] Updated readme --- .gitignore | 1 + README.md | 13 +++++++++++++ sample2.yaml | 4 ++++ 3 files changed, 18 insertions(+) create mode 100644 sample2.yaml diff --git a/.gitignore b/.gitignore index daf913b1..b6c11e22 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,4 @@ _testmain.go *.exe *.test *.prof +yaml diff --git a/README.md b/README.md index eecf0af1..d0748862 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # yaml yaml command line tool written in go + +Allows you to read (and soon update) yaml files given a yaml path. + +Usage: +``` +yaml +``` + +E.g.: +``` +yaml sample.yaml b.c +``` +will output the value of '2'. diff --git a/sample2.yaml b/sample2.yaml new file mode 100644 index 00000000..1d68a2f2 --- /dev/null +++ b/sample2.yaml @@ -0,0 +1,4 @@ +a: Easy! as one two three +b: + c: 3 + d: [3, 4]