README.md in grepg-0.0.4 vs README.md in grepg-0.0.5

- old
+ new

@@ -1,29 +1,37 @@ grepg === `grepg` (pronounced Grep G) is a ruby client for [GrepPage](https://www.greppage.com). It allows you to access your cheat sheets without leaving the terminal. +![grepg screenshot](https://github.com/evidanary/grepg/raw/master/img/screenshot.png) + #Installation -To install `grepg` run +To install `grepg` run ``` gem install grepg ``` +#Requirements +- ruby (tested on 2.1.2) + + #Usage +Enter user and topic name followed by an optional search string. + ``` $ grepg --help Usage: grepg -u user_name -t topic_name [-s search_term] Options: -u, --user=<s> username -t, --topic=<s> topic -s, --search=<s> text to search - -c, --colorize, --no-colorize colorize output (default: true) + -c, --colorize colorize output (default: true) -v, --version Print version and exit -h, --help Show this message Examples: grepg -u evidanary -t css @@ -54,34 +62,29 @@ ``` $ grepg -u kdavis -t git -s stash User: kdavis, Topic: git, Search-Term: stash TO apply your changes git stash --apply - -To list the stash -git stash list - -Git stash -git stash +... ``` -#Defaults File +#Configuration Setup defaults in `~/.grepg.yml` ``` user: evidanary colorize: true ``` -Now, you can access client with +Now, you can do ``` $ grepg -t bootstrap User: evidanary, Topic: bootstrap ... ``` -##Development +#Development To execute tests run ```bundle exec rake spec```. To install the gem locally, first build it using ```bundle exec rake build```. Then install the gem ```gem install pkg/grepg-0.0.1.gem``` -##License +#License grepg is under the [MIT License](http://www.opensource.org/licenses/MIT).