Permalink
Browse files

Updated documentation

  • Loading branch information...
1 parent a258924 commit 26b9ec27bb48fbca05ff93c43accd1f09d1d178a @jrbasso committed Jul 20, 2012
Showing with 41 additions and 2 deletions.
  1. +41 −2 README.md
View
@@ -2,13 +2,52 @@
Gist It is an application to create gists from console. It allows to create
gist from input (ie, `git diff | gistit`) or from a specific file (ie,
-`gistit -f file.txt`).
+`gistit file.txt`).
## Dependencies
-- [cURL](curl.haxx.se)
+- [cURL](http://curl.haxx.se)
- [jansson](https://github.com/akheron/jansson)
+If you are using Ubuntu:
+```shell
+ sudo apt-get install libcurl4-openssl-dev libjansson-dev
+```
+
+## Usage
+
+```shell
+ # Creating a public gist from other app response
+ ls | gistit
+
+ # Creating a private gist from other app response
+ ls | gistit -priv
+
+ # Specifying the gist filename
+ ls | gistit -i list.txt
+
+ # Sending files
+ gistit file.txt
+
+ # Sending multiple files in a private gist
+ gistit -priv file1.txt file2.c
+
+ # Setting gist description
+ gistit -d "This is just a sample" sample.txt
+
+ # Setting gist description, private and with multiple files
+ gistit -d "Sample" -priv file1.txt file2.txt file3.txt
+
+ # Help
+ gistit -h
+
+ # Version
+ gistit -v
+```
+
+By default the `gistit` create the GitHub Gist as anonymous, but you can configure to
+associate with your account. See instructions on [http://gistit.herokuapp.com/].
+
## Compiling
```shell

0 comments on commit 26b9ec2

Please sign in to comment.