tidy up docs & whitespace, declare firstSentences var, update readme

ahoef · Jan 5, 2016 · 5b1a81d · 5b1a81d
1 parent 3ffd196
commit 5b1a81d
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,14 @@
 rygo-ipsum
 ==========
 
-ryan gosling lorem ipsum
+Ryan Gosling lorem ipsum, featured on [Meet The Ipsums](http://meettheipsums.com/)!
 
 http://www.rygo-ipsum.com/
 
-Fire up a simple python server to get started!
+### Development ###
 
-`python -m SimpleHTTPServer 3000`
+Clone or fork this repo, fire up a server from the project directory, 
+
+`$ python -m SimpleHTTPServer 3000`
+
+and head to http://localhost:3000 (or whatever port you choose for your server) to get started!
diff --git a/index.html b/index.html
@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html>
+
   <head>
 
     <meta charset="utf-8">
@@ -40,7 +41,6 @@ <h3>ryan gosling lorem ipsum</h3>
         <li class="medium">medium</li>
         <li class="long">long</li>
       </ul>
-
     </header>
 
     <section class="text"></section>
@@ -57,7 +57,6 @@ <h3>ryan gosling lorem ipsum</h3>
       </section>
     </script>
 
-
   </body>
 
 </html>
diff --git a/js/site.js b/js/site.js
@@ -11,7 +11,7 @@ $(document).ready(function() {
   }
 
   /**
-  * Create a multi-dimensional array of random ipsum text. Its length is determined
+  * Create a multi-dimensional array of random ipsum text. Length is determined
   * by the value of the paragraph & sentence params 
   * @param {number} paragraphCount - number of paragraphs generated
   * @param {number} sentenceCount - number of sentences generated in each paragraph
@@ -20,10 +20,11 @@ $(document).ready(function() {
     $.getJSON('sentences.json',
       function(data) {
         var sentenceArr = _.shuffle(data);
+        var firstSentences = [];
         var paragraphArr = [];
 
         for (var p=0; p < paragraphCount; p++) {
-          var firstSentences = _.first(sentenceArr, sentenceCount);
+          firstSentences = _.first(sentenceArr, sentenceCount);
           paragraphArr.push(firstSentences);
           sentenceArr = _.rest(sentenceArr, sentenceCount);
         }
@@ -33,8 +34,8 @@ $(document).ready(function() {
   }
 
   /**
-  * Create markup based on data from the ipsum array
-  * @param {Array} ipsum - multi-dimensional array of paragraphs -> sentences
+  * Create and insert markup based on data from the ipsum array
+  * @param {Array} ipsum - multi-dimensional array of paragraphs, sentences
   */
   function generateTemplate(ipsum) {
     var templateString = $('.template').html();
@@ -59,4 +60,5 @@ $(document).ready(function() {
   toggleIpsum('.short', 1, 8);
   toggleIpsum('.medium', 3, 5);
   toggleIpsum('.long', 5, 5);
+
 });