Permalink
Browse files

Updated README

  • Loading branch information...
1 parent 849882f commit b2319a9cc24dcbd22658b241519e64b9624c2eda @jrbasso committed Jul 1, 2012
Showing with 21 additions and 0 deletions.
  1. +21 −0 README.md
View
@@ -1,5 +1,9 @@
# Gist It!
+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`).
+
## Compiling
```shell
@@ -13,3 +17,20 @@
cd ..
make
```
+
+## Web Application
+
+The web application uses [node.js](http://nodejs.org/). To run, it requires two
+environment variables:
+
+- `GITHUB_CLIENT_ID` It contains the client ID of GitHub application
+- `GITHUB_SECRET_KEY` It contains the secret key of GitHub application
+
+### Deploying
+
+The web application can be deployed easily to [heroku](http://www.heroku.com/).
+
+- Create the application: `heroku create <APPLICATION_NAME>`
+- Push the code: `git push heroku master`
+- Set the GitHub application information: `heroku config:add GITHUB_CLIENT_ID=<CLIENT_ID>`
+and `heroku config:add GITHUB_SECRET_KEY=<SECRET_KEY>`

0 comments on commit b2319a9

Please sign in to comment.