Added doco

mkdocs/convert.md

@@ -0,0 +1,5 @@
+### 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.

mkdocs/create.md

@@ -0,0 +1,42 @@
+Yaml files can be created using the 'new' command. This works in the same way as the write command, but you don't pass in an existing Yaml file.
+
+```
+yaml n <path> <new value>
+```
+
+### Creating a simple yaml file
+```bash
+yaml n b.c cat
+```
+will output:
+```yaml
+b:
+  c: cat
+```
+
+### Creating using a create script
+Create scripts follow the same format as the update scripts.
+
+Given a script create_instructions.yaml of:
+```yaml
+b.c: 3
+b.e[0].name: Howdy Partner
+```
+then
+
+```bash
+yaml n -s create_instructions.yaml
+```
+will output:
+```yaml
+b:
+  c: 3
+  e:
+    - name: Howdy Partner
+```
+
+You can also pipe the instructions in:
+
+```bash
+cat create_instructions.yaml | yaml n -s -
+```

mkdocs/index.md

@@ -0,0 +1,16 @@
+# yaml
+yaml is a lightweight and flexible command-line YAML processor
+
+The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
+
+### [download latest binary](https://github.com/mikefarah/yaml/releases/latest)
+
+### get the source
+```bash
+go get github.com/mikefarah/yaml
+```
+
+[.zip](https://github.com/mikefarah/yaml/zipball/master) or [tar.gz](https://github.com/mikefarah/yaml/tarball/master)
+
+[View on GitHub](https://github.com/mikefarah/yaml)
+

mkdocs/read.md

@@ -0,0 +1,91 @@
+```
+yaml r <yaml file> <path>
+```
+
+### Basic
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+```
+then
+```bash
+yaml r sample.yaml b.c
+```
+will output the value of '2'.
+
+### From Stdin
+Given a sample.yaml file of:
+```bash
+cat sample.yaml | yaml r - b.c
+```
+will output the value of '2'.
+
+### Splat
+Given a sample.yaml file of:
+```yaml
+---
+bob:
+  item1:
+    cats: bananas
+  item2:
+    cats: apples
+```
+then
+```bash
+yaml r sample.yaml bob.*.cats
+```
+will output
+```yaml
+- bananas
+- apples
+```
+
+### Handling '.' in the yaml key
+Given a sample.yaml file of:
+```yaml
+b.x:
+  c: 2
+```
+then
+```bash
+yaml r sample.yaml \"b.x\".c
+```
+will output the value of '2'.
+
+### Arrays
+You can give an index to access a specific element:
+e.g.: given a sample file of
+```yaml
+b:
+  e:
+    - name: fred
+      value: 3
+    - name: sam
+      value: 4
+```
+then
+```
+yaml r sample.yaml b.e[1].name
+```
+will output 'sam'
+
+### Array Splat
+e.g.: given a sample file of
+```yaml
+b:
+  e:
+    - name: fred
+      value: 3
+    - name: sam
+      value: 4
+```
+then
+```
+yaml r sample.yaml b.e[*].name
+```
+will output:
+```
+- fred
+- sam
+```

mkdocs/write.md

@@ -0,0 +1,88 @@
+```
+yaml w <yaml file> <path> <new value>
+```
+
+### To Stdout
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+```
+then
+```bash
+yaml w sample.yaml b.c cat
+```
+will output:
+```yaml
+b:
+  c: cat
+```
+
+### From STDIN
+```bash
+cat sample.yaml | yaml w - b.c blah
+```
+
+### Adding new fields
+Any missing fields in the path will be created on the fly.
+
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+```
+then
+```bash
+yaml w sample.yaml b.d[0] "new thing"
+```
+will output:
+```yaml
+b:
+  c: cat
+  d:
+    - new thing
+```
+
+### Updating files in-place
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+```
+then
+```bash
+yaml w -i sample.yaml b.c cat
+```
+will update the sample.yaml file so that the value of 'c' is cat.
+
+
+### Updating multiple values with a script
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+  e:
+    - name: Billy Bob
+```
+and a script update_instructions.yaml of:
+```yaml
+b.c: 3
+b.e[0].name: Howdy Partner
+```
+then
+
+```bash
+yaml w -s update_instructions.yaml sample.yaml
+```
+will output:
+```yaml
+b:
+  c: 3
+  e:
+    - name: Howdy Partner
+```
+
+And, of course, you can pipe the instructions in using '-':
+```bash
+cat update_instructions.yaml | yaml w -s - sample.yaml
+```