Skip to content

Commit

Permalink
Readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
bronzehedwick committed Nov 1, 2012
1 parent 2a93ad9 commit 42d8f05
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,32 @@ git-growl

Git hooks that provide local growl notifications

A project with admittedly limited practical uses, it does provide pretty, if largely redundant, git notifications. See the TODO section for when it could actually be useful.


Installation
------------
For easy installation, just run the command below.
```sh
curl http://goo.gl/ltLch -L -o - | sh
```

Or, to install manually, checkout the repository in your home directory, changing the name to .git-growl.

Setup
-----
Navigate to the git repository you want to setup, then run
```sh
sh ~/.git-growl/install.sh
```
Or on Debian distros (or any distro that uses dash instead of bash as the default sh), run
```sh
bash ~/.git-growl/install.sh
```

TODO
----
* Add server side scripts to send notifications to clients (make this project useful!)
* Add an uninstall script
* Add a windows version

0 comments on commit 42d8f05

Please sign in to comment.