Permalink
Browse files

Updated documentation in examples

  • Loading branch information...
1 parent 0d9466f commit 21a9020fbd9ad6b9aaa123f89c99516828dbc355 @rafeca rafeca committed Sep 28, 2011
@@ -5,13 +5,13 @@
<h2>Running this example</h2>
<ul>
-<li><p>First of all, you have to register into <a href="http://connfu.com and create">connFu.com</a>
+<li><p>First of all, you have to register into <a href="https://connfu.com">connFu.com</a>
an application. You will receive an <strong>application token</strong> which will be very useful ;)</p></li>
<li><p>Then, install the connFu npm package:</p>
<pre><code> $ npm install connfu
</code></pre></li>
-<li><p>Then get the source of this example from <a href="https://github.com/dogfood20/connfu-node/blob/master/examples/fancy-connfu-application.js">here</a>
+<li><p>Then get the source of this example from <a href="https://github.com/bluevialabs/connfu-node/blob/master/examples/fancy-connfu-application.js">here</a>
and run it!</p>
<pre><code> $ node fancy-connfu-application.js &lt;application_token&gt;
View
@@ -5,7 +5,23 @@
with <em>Grow</em> and <code>growlnotifier</code> installed.</p>
<p>Once launched, it listens to all the configured events in the application
-and shows them as a Growl notification</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h2>Annotated source</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Require <code>connfu</code> and <code>growl</code> packages</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">connFu = </span><span class="nx">require</span> <span class="s1">&#39;connfu&#39;</span>
+and shows them as a Growl notification</p>
+
+<h2>Running this example</h2>
+
+<ul>
+<li><p>First of all, you have to register into <a href="https://connfu.com">connFu.com</a>
+an application. You will receive an <strong>application token</strong> which will be very useful ;)</p></li>
+<li><p>Then, install the <code>connFu</code> and <code>growl</code> npm packages:</p>
+
+<pre><code> $ npm install growl connfu
+</code></pre></li>
+<li><p>Then get the source of this example from <a href="https://github.com/bluevialabs/connfu-node/blob/master/examples/growl-notifier.coffee">here</a>
+and run it!</p>
+
+<pre><code> $ coffee growl-notifier.coffee &lt;application_token&gt;
+</code></pre></li>
+</ul> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h2>Annotated source</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Require <code>connfu</code> and <code>growl</code> packages</p> </td> <td class="code"> <div class="highlight"><pre><span class="nv">connFu = </span><span class="nx">require</span> <span class="s1">&#39;connfu&#39;</span>
<span class="nv">growl = </span><span class="nx">require</span> <span class="s1">&#39;growl&#39;</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>Check that we receive the <code>application_token</code> as an argument</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">if</span> <span class="nx">process</span><span class="p">.</span><span class="nx">argv</span><span class="p">.</span><span class="nx">length</span> <span class="o">&lt;</span> <span class="mi">3</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="s2">&quot;Usage: coffee grow-notifier.coffee &lt;application_token&gt;&quot;</span>
<span class="nx">process</span><span class="p">.</span><span class="nx">exit</span> <span class="mi">1</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>Check if we have <code>growlnotifier</code> installed. To install it, download the
@@ -5,14 +5,14 @@
// Running this example
// --------------------
//
-// * First of all, you have to register into [connFu.com](http://connfu.com and create)
+// * First of all, you have to register into [connFu.com](https://connfu.com)
// an application. You will receive an **application token** which will be very useful ;)
//
// * Then, install the connFu npm package:
//
// $ npm install connfu
//
-// * Then get the source of this example from [here](https://github.com/dogfood20/connfu-node/blob/master/examples/fancy-connfu-application.js)
+// * Then get the source of this example from [here](https://github.com/bluevialabs/connfu-node/blob/master/examples/fancy-connfu-application.js)
// and run it!
//
// $ node fancy-connfu-application.js <application_token>
@@ -6,6 +6,20 @@
#
# Once launched, it listens to all the configured events in the application
# and shows them as a Growl notification
+#
+### Running this example
+#
+# * First of all, you have to register into [connFu.com](https://connfu.com)
+# an application. You will receive an **application token** which will be very useful ;)
+#
+# * Then, install the `connFu` and `growl` npm packages:
+#
+# $ npm install growl connfu
+#
+# * Then get the source of this example from [here](https://github.com/bluevialabs/connfu-node/blob/master/examples/growl-notifier.coffee)
+# and run it!
+#
+# $ coffee growl-notifier.coffee <application_token>
# Annotated source
# ----------------

0 comments on commit 21a9020

Please sign in to comment.