Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
miyagawa committed Jun 13, 2009
1 parent ba2b9d2 commit e34e745
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.mkdn
@@ -1,6 +1,12 @@
This is Github Growler: fetches GitHub timeline and growls as new activies are coming in.

This is a perl script that runs as a daemon. You need to install CPAN module dependencies by running `cpan -i`. See `man cpan` for details.
## Install

There's a binary build for Mac OS X Leopard available at [Downloads](http://github.com/miyagawa/github-growler/downloads).

If you're trying to run this on other platforms, just run `github-growler.pl`. You might need to install its CPAN module dependencies with `cpan -i . ` command.

## Configurations

You need to set `github.user` and `github.token` in your [global git config](http://github.com/guides/local-github-config) or pass them to the command line arguments.

Expand All @@ -9,8 +15,6 @@ By default this scripts fetches the github updates every 300 seconds and display
defaults write net.bulknews.GitHubGrowler interval 180
defaults write net.bulknews.GitHubGrowler maxGrowls 5

It's in my TODO to make it a standalone app. I guess we could use [Platypus](http://www.sveinbjorn.org/platypus) and bundle all CPAN dependencies in its Resources folder by removing the non pure-perl module dependency (i.e. XML::LibXML).

## Screenshots

<a href="http://www.flickr.com/photos/bulknews/3354348975/" title="Github Growler by miyagawa, on Flickr"><img src="http://farm4.static.flickr.com/3617/3354348975_85fc99bf65_o.jpg" width="326" height="542" alt="Github Growler" /></a>
Expand Down

0 comments on commit e34e745

Please sign in to comment.