demo and readme improved

juanbrujo · Jun 17, 2015 · 61cd3cd · 61cd3cd
1 parent 4709dc8
commit 61cd3cd
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -3,11 +3,21 @@
 ![Bower version](https://img.shields.io/bower/v/sluggin.svg)
 ![NPM version](https://badge.fury.io/js/sluggin.png)
 
-> Converts string into websafe-friendly-clean piece of text 
+> Converts string/array into websafe-friendly-clean piece of text 
+
+###Install
+
+```
+$ npm install sluggin
+```
+
+```
+$ bower install sluggin
+```
 
 ###Use
 
-**Strings:**
+**String:**
 ```
 Sluggin( "I used to have ugly text. Now I just have 1." );
 ➤ i-used-to-have-ugly-text-now-i-just-have-1
@@ -37,7 +47,12 @@ Sluggin( [
     "J'ai l'habitude d'avoir un texte laid. Je dois maintenant juste 1.",
     "Früher habe ich hässlich Text. Jetzt habe ich nur noch 1."
   ] );
-➤ ["i-used-to-have-ugly-text-now-i-just-have-1", "solia-tener-texto-feo-ahora-solo-tengo-1", "jai-lhabitude-davoir-un-texte-laid-je-dois-maintenant-juste-1", "fruher-habe-ich-hasslich-text-jetzt-habe-ich-nur-noch-1"]
+➤ [
+    "i-used-to-have-ugly-text-now-i-just-have-1", 
+    "solia-tener-texto-feo-ahora-solo-tengo-1", 
+    "jai-lhabitude-davoir-un-texte-laid-je-dois-maintenant-juste-1", 
+    "fruher-habe-ich-hasslich-text-jetzt-habe-ich-nur-noch-1"
+  ]
 ```
 
 **Thanks:**

diff --git a/demo/index.html b/demo/index.html
@@ -15,24 +15,36 @@ <h1 class="f3 f2-m mega-ns b db-ns mrs mrn-ns mbn ttu mtn pulse-letters">
           Sluggin.js
         </h1>
         <p class="f5 f3-ns dib db-ns fw1 phs mbn mbx-ns aqua">
-          Converts string into websafe-friendly-clean piece of text
+          Converts string/array into websafe-friendly-clean piece of text
           <small class="ws-nowrap db f5 mts mtm-ns">2.4kb (minified)</small>
         </p>
-      </div>
-      <div class="pvm">
-        <a title="Sluggin.js" href="//github.com/juanbrujo/Sluggin.js"
+        </div>
+        <div class="pvm">
+           <a title="Sluggin.js" href="//github.com/juanbrujo/Sluggin.js"
            class="small link tc br2 bw1 pas pam-ns btn--animated">View on Github ▸</a>
+        </div>
       </div>
     </header>
   </div>
   <main>
     <section class="bg-near-white dt h-100 navy pvx pvxl-ns">
       <div class="dtc v-mid">
+        <div class="mw7 center phm phl-ns tl tl-ns">
+          <h1 class="f4 ttu book">Install</h1>
+          <hr>
+          <section class="f4 f3-ns list pln lh-copy">
+            <article class="pvs">
+              <pre>$ npm install sluggin</pre>
+              <pre>$ bower install sluggin</pre>
+            </article>
+          </section>
+        </div>
         <div class="mw7 center phm phl-ns tl tl-ns">
           <h1 class="f4 ttu book">Use</h1>
+          <hr>
           <section class="f4 f3-ns list pln lh-copy">
             <article class="pvs">
-            	<pre>Sluggin( "Text I want to transform!" );</pre>
+              <pre>Sluggin( "Text I want to transform!" );</pre>
             </article>
           </section>
         </div>
@@ -50,7 +62,7 @@ <h1 class="f4 ttu book">Live Demo</h1>
               <p id="slugginoutput">Output: </p>
             </article>
           </section>
-          <h1 class="f4 ttu book">Languages Demos</h1>
+          <h1 class="f4 ttu book">String Demos</h1>
           <hr>
           <section class="f4 f3-ns list pln lh-copy">
             <article class="pvs demos">