README.md in github_cli-0.0.1.pre vs README.md in github_cli-0.1.0

- old
+ new

@@ -1,8 +1,11 @@ -# GithubCli +# GithubCLI [![Build Status](https://secure.travis-ci.org/peter-murach/github_cli.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/github_cli.png?travis)][gemnasium] +[travis]: http://travis-ci.org/peter-murach/github_cli +[gemnasium]: https://gemnasium.com/peter-murach/github_cli + CLI-based access to GitHub API v3 that works hand-in-hand with 'github_api' gem. This gem does not work yet at this stage, stay tuned. ## Installation @@ -23,9 +26,28 @@ Run it: ```shell $ ghc +``` + +### Initialize a configuration file + +The first step is to create a configuration file: + +```shell +$ ghc init +``` + +This will setup a `.githubrc` configuration file in your home directory with +all the global settings. + +### Getting a list of commands + +You can list all GitHub APIs comamnds: + +```shell +$ ghc list ``` ## Contributing 1. Fork it