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

- old
+ new

@@ -1,43 +1,60 @@ -#grepg -###The ruby client for greppage +grepg +=== -`grepg` (pronounced Grep G) is a ruby client for [GrepPage](https://www.greppage.com). It is packaged as a gem. +`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. -###Install -To install `grepg` run ```gem install grepg``` +#Installation +To install `grepg` run -###Examples ``` +gem install grepg +``` + +#Usage + +``` +$ grepg --help Usage: -grepg user_name topic_name [-s search_term] + 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) + -v, --version Print version and exit + -h, --help Show this message + +Examples: + grepg -u evidanary -t css + greppg -u evidanary -t css -s color + +Defaults: + To set default user, create a file in ~/.grepg.yml with + default_user: test ``` -Get all items/microdoc for a topic on any collection. +For example, to get all cheats for the `git` topic for user `kdavis` + ``` -$ grepg kdavis git -User: kdavis, Topic: git +$ grepg -u evidanary -t git +User: evidanary, Topic: git push tags to remote / Github git push --tags remove delete tag git tag -d v0.0.8 - -list branches that have not been merged -git branch --no-merged - -list branches merged into master -git branch --merged master ... ``` Search for a specific string ``` -$ grepg kdavis git -s stash +$ 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 @@ -45,10 +62,26 @@ Git stash git stash ``` +#Defaults File +Setup defaults in `~/.grepg.yml` + +``` +user: evidanary +colorize: true +``` + +Now, you can access client with + +``` +$ grepg -t bootstrap +User: evidanary, Topic: bootstrap +... +``` + ##Development -To run 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``` +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 grepg is under the [MIT License](http://www.opensource.org/licenses/MIT).