nikki 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85460eb9bdca5b6596634ee5f5434474f7363ca1
-  data.tar.gz: 8c7eea3c8ef4b46b4418e1036bf5764f5a259118
+  metadata.gz: ea6c3fbdef3033405967dbb776f8e7ccee6e1d66
+  data.tar.gz: 5cd97d3694bb90b344c32f587a90a5588f4f30c6
 SHA512:
-  metadata.gz: f1621ef6b8f701cfecbbd5ebe06644cdb3cb943036edb161be6703654b1be1a8b39e62e2da9a2448bd2c530036895e79ffed668a6f1df872786140c9c80a544a
-  data.tar.gz: dfb82f63953ac0591418c3ac1631a283eb6ee097ce6171a76bb345515507b04e6d1610243b276fe4ac59f2d22a911d56015158ad0314ce349af1878f22c2de5d
+  metadata.gz: 0ed300ecd2c51e4c51320fd04c93c943dcf358c3a3db304d82bd5838dfea24017b79dd8564120d1bb265f154a8d99782271c7fa920ba9f925703c6b75c1bd3fc
+  data.tar.gz: 79fb38bed057c4af7f44e40f668803a3d6c8db91569e3962f24a9bfa0ed4ccb9c467d9d4356fbba53544775a7f5324d4b3cbb815b67c5df0656f0a2479a6a251

data/doc/Generator.html

@@ -119,7 +119,7 @@
   <div class="discussion">
     
 <p>This is the main class that interfaces with Thor&#39;s methods and does all
-the heavy lifting for Nikki. It&#39;s a bit of a “God” object. Sorries.</p>
+the heavy lifting for Nikki.  It&#39;s a bit of a “God” object. Sorries.</p>
 
 
   </div>
@@ -185,7 +185,31 @@ the heavy lifting for Nikki. It&#39;s a bit of a “God” object. Sorries.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#new-instance_method" title="#new (instance method)">- (Object) <strong>new</strong>(*args) </a>
+      <a href="#ls-instance_method" title="#ls (instance method)">- (String) <strong>ls</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Display Nikki&#39;s latest entires.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#new-instance_method" title="#new (instance method)">- (Hash) <strong>new</strong>(*entry) </a>
     
 
     
@@ -228,6 +252,31 @@ didn&#39;t update the journal the previous day.</p>
 <p>Open Nikki journal in configured text editor.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#publish-instance_method" title="#publish (instance method)">- (Object) <strong>publish</strong>(year) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>method calls the `markdown` method and creates a MultiMarkdown document
+with one big description list.</p>
+</div></span>
+  
 </li>
 
       
@@ -288,115 +337,106 @@ didn&#39;t update the journal the previous day.</p>
   
     <li>
       
-        <span class='name'>--editor</span>
+        <span class='name'>options</span>
       
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>(<a href=":editor">read_config</a>) Sets Nikki&#39;s editor to open journal
-file</p>
+<p>The options for configuring Nikki</p>
 </div>
       
     </li>
   
-    <li>
-      
-        <span class='name'>--yesterday</span>
-      
-      
-        <span class='type'></span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>Set `<a href=":updated">settings</a>` to yesterday</p>
-</div>
-      
-    </li>
+</ul>
+
   
-    <li>
-      
-        <span class='name'>--today</span>
-      
-      
-        <span class='type'></span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>Set `<a href=":updated">settings</a>` to today</p>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+72
+73
+74
+75
+76
+77
+78
+79
+80</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 72</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
+  <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_read_config'>read_config</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='op'>-</span><span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:yesterday</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:today</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_write_config'>write_config</span><span class='lparen'>(</span><span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_to_yaml'>to_yaml</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:print</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:latest</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
-      
-    </li>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ls-instance_method">
   
-    <li>
-      
-        <span class='name'>--print</span>
-      
-      
-        <span class='type'></span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>Prints Nikki&#39;s configuration settings to STDOUT</p>
+    - (<tt>String</tt>) <strong>ls</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Display Nikki&#39;s latest entires</p>
+
+
+  </div>
 </div>
-      
-    </li>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
     <li>
       
-        <span class='name'>--latest</span>
-      
       
-        <span class='type'></span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
-        &mdash;
-        <div class='inline'>
-<p>Prints Nikki&#39;s latest entries to STDOUT</p>
-</div>
-      
     </li>
   
 </ul>
 
-
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-64
-65
-66
-67
-68
-69
-70
-71
-72</pre>
+55
+56
+57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 55</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
-  <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
-  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_read_config'>read_config</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='op'>-</span><span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:yesterday</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:today</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_write_config'>write_config</span><span class='lparen'>(</span><span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_to_yaml'>to_yaml</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:print</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:latest</span><span class='rbracket'>]</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_ls'>ls</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -406,7 +446,7 @@ file</p>
       <div class="method_details ">
   <h3 class="signature " id="new-instance_method">
   
-    - (<tt>Object</tt>) <strong>new</strong>(*args) 
+    - (<tt>Hash</tt>) <strong>new</strong>(*entry) 
   
 
   
@@ -416,9 +456,9 @@ file</p>
   <div class="discussion">
     
 <p>Add entry to journal Will open your configured text editor on OS X if you
-didn&#39;t update the journal the previous day. This will allow you to add
-missing entries in bulk. It reads the settings in from the config YAML file
-and changes the date updated. It does the same with the journal file,
+didn&#39;t update the journal the previous day.  This will allow you to add
+missing entries in bulk.  It reads the settings in from the config YAML
+file and changes the date updated.  It does the same with the journal file,
 reading in the YAML and merging the hash of entries, and then saves the
 YAML back again. There&#39;s also a method to check off a corresponding
 task in OmniFocus at the end.</p>
@@ -427,12 +467,20 @@ task in OmniFocus at the end.</p>
   </div>
 </div>
 <div class="tags">
-  <p class="tag_title">Parameters:</p>
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>nikki new &#39;This is a thing I learned today!&#39;</span><span class='tstring_end'>&quot;</span></span></code></pre>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
 <ul class="param">
   
     <li>
       
-        <span class='name'>entry</span>
+        <span class='name'>--entry</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -448,6 +496,24 @@ task in OmniFocus at the end.</p>
   
 </ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Returns a Hash which is then saved in a YAML file.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -455,26 +521,26 @@ task in OmniFocus at the end.</p>
       <pre class="lines">
 
 
-28
-29
-30
-31
-32
 33
 34
 35
 36
 37
 38
-39</pre>
+39
+40
+41
+42
+43
+44</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 28</span>
+      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 33</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
   <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_today'>today</span>
-  <span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_entry_hash'>entry_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_today'>today</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_entry'>entry</span> <span class='rbrace'>}</span>
   <span class='id identifier rubyid_journal'>journal</span> <span class='op'>=</span> <span class='id identifier rubyid_read_file'>read_file</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_entry_hash'>entry_hash</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_write_file'>write_file</span><span class='lparen'>(</span><span class='id identifier rubyid_journal'>journal</span><span class='rparen'>)</span>
@@ -514,23 +580,82 @@ task in OmniFocus at the end.</p>
       <pre class="lines">
 
 
-44
-45
-46
-47
 48
 49
 50</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 48</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:marked</span><span class='rbracket'>]</span>
-    <span class='backtick'>%x{</span><span class='tstring_content'>open -a Marked </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='embexpr_end'>}</span><span class='tstring_end'>}</span></span>
-  <span class='kw'>else</span>
-    <span class='backtick'>%x{</span><span class='tstring_content'>open -a &quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_editor'>editor</span><span class='embexpr_end'>}</span><span class='tstring_content'>&quot; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='embexpr_end'>}</span><span class='tstring_end'>}</span></span>
-  <span class='kw'>end</span>
+  <span class='backtick'>%x{</span><span class='tstring_content'>open -a &quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_editor'>editor</span><span class='embexpr_end'>}</span><span class='tstring_content'>&quot; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='embexpr_end'>}</span><span class='tstring_end'>}</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="publish-instance_method">
+  
+    - (<tt>Object</tt>) <strong>publish</strong>(year) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>method calls the `markdown` method and creates a MultiMarkdown document
+with one big description list.  This format is subject to change, but for
+now, it seems good enough.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>year</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>of journal entries you wish to pubish as Markdown This</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+87
+88
+89
+90
+91</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 87</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_publish'>publish</span><span class='lparen'>(</span><span class='id identifier rubyid_year'>year</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_md_path'>md_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>nikki_markdown_</span><span class='embexpr_beg'>#{</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='embexpr_end'>}</span><span class='tstring_content'>.md</span><span class='tstring_end'>&quot;</span></span>
+  <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_md_path'>md_path</span><span class='comma'>,</span> <span class='id identifier rubyid_markdown'>markdown</span><span class='lparen'>(</span><span class='id identifier rubyid_read_file'>read_file</span><span class='comma'>,</span> <span class='id identifier rubyid_year'>year</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rparen'>)</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Markdown saved to \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_md_path'>md_path</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;.</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -587,7 +712,7 @@ task in OmniFocus at the end.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/Nikki.html

@@ -128,7 +128,7 @@
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.4.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.5.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -144,7 +144,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/_index.html

@@ -128,7 +128,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/file.README.html

@@ -76,7 +76,7 @@
     <iframe id="search_frame"></iframe>
 
     <div id="content"><div id='filecontents'><p><a href="http://badge.fury.io/rb/nikki"><img src="https://badge.fury.io/rb/nikki.png" alt="Gem Version"></a>
-<a href="http://inch-pages.github.io/github/brandonpittman/nikki"><img src="http://inch-pages.github.io/github/brandonpittman/nikki.png" alt="Inline docs"></a></p>
+<a href="http://inch-ci.org/github/brandonpittman/nikki"><img src="http://inch-ci.org/github/brandonpittman/nikki.png" alt="Inline docs"></a></p>
 
 <h1>nikki</h1>
 
@@ -114,6 +114,19 @@
 </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_setup'>setup</span>           <span class='comment'># Creates new Nikki and config files.
 </span></code></pre>
 
+<h2>Examples</h2>
+
+<h3>New entry</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Brandon Pittman is a super cool guy.</span><span class='tstring_end'>&quot;</span></span>
+</code></pre>
+
+<h3>Configure Nikki</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_yesterday'>yesterday</span>  <span class='comment'># Reset last updated `datetime`
+</span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_list'>list</span>       <span class='comment'># Prints latest entries
+</span></code></pre>
+
 <h2>Contributing</h2>
 
 <ol>
@@ -126,7 +139,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/index.html

@@ -76,7 +76,7 @@
     <iframe id="search_frame"></iframe>
 
     <div id="content"><div id='filecontents'><p><a href="http://badge.fury.io/rb/nikki"><img src="https://badge.fury.io/rb/nikki.png" alt="Gem Version"></a>
-<a href="http://inch-pages.github.io/github/brandonpittman/nikki"><img src="http://inch-pages.github.io/github/brandonpittman/nikki.png" alt="Inline docs"></a></p>
+<a href="http://inch-ci.org/github/brandonpittman/nikki"><img src="http://inch-ci.org/github/brandonpittman/nikki.png" alt="Inline docs"></a></p>
 
 <h1>nikki</h1>
 
@@ -114,6 +114,19 @@
 </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_setup'>setup</span>           <span class='comment'># Creates new Nikki and config files.
 </span></code></pre>
 
+<h2>Examples</h2>
+
+<h3>New entry</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Brandon Pittman is a super cool guy.</span><span class='tstring_end'>&quot;</span></span>
+</code></pre>
+
+<h3>Configure Nikki</h3>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_yesterday'>yesterday</span>  <span class='comment'># Reset last updated `datetime`
+</span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_list'>list</span>       <span class='comment'># Prints latest entries
+</span></code></pre>
+
 <h2>Contributing</h2>
 
 <ol>
@@ -126,7 +139,7 @@
 </div></div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/method_list.html

@@ -62,17 +62,29 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Generator.html#new-instance_method" title="Generator#new (method)">#new</a></span>
+    <span class='object_link'><a href="Generator.html#ls-instance_method" title="Generator#ls (method)">#ls</a></span>
     <small>Generator</small>
   </li>
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="Generator.html#new-instance_method" title="Generator#new (method)">#new</a></span>
+    <small>Generator</small>
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="Generator.html#open-instance_method" title="Generator#open (method)">#open</a></span>
     <small>Generator</small>
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="Generator.html#publish-instance_method" title="Generator#publish (method)">#publish</a></span>
+    <small>Generator</small>
+  </li>
+  
+
   <li class="r2 ">
     <span class='object_link'><a href="Generator.html#setup-instance_method" title="Generator#setup (method)">#setup</a></span>
     <small>Generator</small>

data/doc/requirements/step_transformers.html

@@ -131,7 +131,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/requirements/tags.html

@@ -184,7 +184,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/requirements.html

@@ -123,7 +123,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/doc/top-level-namespace.html

@@ -119,7 +119,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri May 30 11:37:52 2014 by
+  Generated on Tue Sep  9 16:01:49 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.2).
 </div>

data/lib/nikki/version.rb

@@ -1,5 +1,5 @@
 # Sets version for RubyGems
 module Nikki
   # Sets version for RubyGems
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nikki
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Brandon Pittman