<div class="announce instapaper_body mkdn" data-path="README.mkdn" id="readme"><article class="markdown-body entry-content" itemprop="mainContentOfPage"><p>This is Github Growler: fetches GitHub timeline and growls as new activies are coming in.</p>

<h2>
<a name="user-content-install" class="anchor" href="#install" aria-hidden="true"><span class="octicon octicon-link"></span></a>Install</h2>

<p>There's a binary build for Mac OS X Leopard available at <a href="http://github.com/miyagawa/github-growler/downloads">Downloads</a>.</p>

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

<h2>
<a name="user-content-configurations" class="anchor" href="#configurations" aria-hidden="true"><span class="octicon octicon-link"></span></a>Configurations</h2>

<p>You need to set <code>github.user</code> and <code>github.token</code> in your <a href="http://github.com/guides/local-github-config">global git config</a> or pass them to the command line arguments.</p>

<p>By default this scripts fetches the github updates every 300 seconds and displays at most 10 Growl notification per fetch and you can change the both settings with Mac OS X preferences:</p>

<pre><code>defaults write net.bulknews.GitHubGrowler interval 180
defaults write net.bulknews.GitHubGrowler maxGrowls 5
</code></pre>

<h2>
<a name="user-content-screenshots" class="anchor" href="#screenshots" aria-hidden="true"><span class="octicon octicon-link"></span></a>Screenshots</h2>

<p><a href="http://www.flickr.com/photos/bulknews/3354348975/" title="Github Growler by miyagawa, on Flickr"><img src="https://camo.githubusercontent.com/5977aa8097d315dfc8ccb8e0e3b52af1590aa92b/687474703a2f2f6661726d342e7374617469632e666c69636b722e636f6d2f333631372f333335343334383937355f383566633939626636355f6f2e6a7067" width="326" height="542" alt="Github Growler" data-canonical-src="http://farm4.static.flickr.com/3617/3354348975_85fc99bf65_o.jpg" style="max-width:100%;"></a></p>

<p><a href="http://www.flickr.com/photos/bulknews/3354353545/" title="Github Growler Preferences by miyagawa, on Flickr"><img src="https://camo.githubusercontent.com/6c8d78aebb4cd6f32d683010f1471d3bd720fb1e/687474703a2f2f6661726d342e7374617469632e666c69636b722e636f6d2f333538372f333335343335333534355f396437306533303832375f6f2e6a7067" width="568" height="433" alt="Github Growler Preferences" data-canonical-src="http://farm4.static.flickr.com/3587/3354353545_9d70e30827_o.jpg" style="max-width:100%;"></a></p></article></div>