README.md in yq-0.0.1 vs README.md in yq-0.0.2
- old
+ new
@@ -1,8 +1,8 @@
# Yq
-TODO: Write a gem description
+Use `yq` to parse YAML documents using [JMESPath](http://jmespath.org/). This gem is a simple wrapper around the [jmespath gem](https://github.com/jmespath/jmespath.rb).
## Installation
Add this line to your application's Gemfile:
@@ -18,10 +18,23 @@
$ gem install yq
## Usage
-TODO: Write usage instructions here
+`yq` takes input from STDIN:
+
+```
+$ cat stuff.yml | yq '.'
+---
+stuff:
+ foo:
+ bar: baz
+
+$ cat stuff.yml | yq 'stuff.foo'
+---
+bar: baz
+
+```
## Contributing
1. Fork it ( https://github.com/[my-github-username]/yq/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)