Packaging polish.

ericf · Apr 30, 2011 · 8590455 · 8590455
1 parent 9dfb9cf
commit 8590455
Show file tree

Hide file tree

Showing 8 changed files with 493 additions and 471 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,2 +1,6 @@
-._*
 .git/
+contrib/
+node_modules/
+tmp/
+._*
+.DS_Store
diff --git a/bin/selleck b/bin/selleck
@@ -64,13 +64,6 @@ var fs        = require('fs'),
         "  --out-meta <filename>  Write combined project and component JSON metadata to",
         "                         the specified filename.",
         ""
-    ].join('\n'),
-
-    version = [
-        "Selleck 0.1.3",
-        "Copyright (c) 2011 Yahoo! Inc. All rights reserved.",
-        "https://github.com/rgrove/selleck/",
-        ""
     ].join('\n');
 
 // Process command line parameters.
@@ -156,6 +149,15 @@ while ((arg = argv.shift())) {
 
     case '--version':
     case '-v':
+        pkg = JSON.parse(fs.readFileSync(__dirname + '/../package.json', 'utf-8'));
+
+        version = [
+            "Selleck " + pkg.version,
+            pkg.copyright,
+            pkg.homepage,
+            ""
+        ].join('\n');
+
         // See rant above re. forcing Node to flush stdout before exiting.
         process.stdout.write(version);
         while (!process.stdout.flush()) {};

diff --git a/docs/html/assets/css/main.css b/docs/html/assets/css/main.css
@@ -114,6 +114,7 @@ table code, table kbd, table samp,
 
 pre.code, pre.terminal {
     overflow-x: auto;
+    *overflow-x: scroll;
     padding: 0.3em 0.6em;
 }
 

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -3,17 +3,20 @@
 <head>
     <meta charset="utf-8">
     <title>Selleck User Guide</title>
-    <link rel="stylesheet" href="http://yui.yahooapis.com/3.3.0/build/cssgrids/grids-min.css">
+    <link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.3.0&#x2F;build&#x2F;cssgrids&#x2F;grids-min.css">
     <link rel="stylesheet" href="assets/css/main.css">
     <link rel="stylesheet" href="assets/vendor/prettify/prettify-min.css">
-    <script src="http://yui.yahooapis.com/combo?3.3.0/build/yui/yui-min.js&amp;3.3.0/build/loader/loader-min.js"></script>
+    <script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.3.0&#x2F;build&#x2F;yui&#x2F;yui-min.js&amp;3.3.0&#x2F;build&#x2F;loader&#x2F;loader-min.js"></script>
 </head>
 <body>
 
 <div id="doc">
     <h1>Selleck User Guide</h1>
 
-            <a href="#toc" class="jump">Jump to Table of Contents</a>
+
+        <a href="#toc" class="jump">Jump to Table of Contents</a>
+
+
     <div class="yui3-g">
         <div id="main" class="yui3-u">
             <div class="content"><div class="intro">
@@ -34,14 +37,15 @@ <h2 id="installation">Installation</h2>
 Install Selleck using npm:
 </p>
 
-<pre class="terminal"><span class="noselect">$ </span>npm install selleck</pre>
+<pre class="terminal"><span class="noselect">$ </span>npm install selleck -g</pre>
 
 
 <p>
-Or just clone the <a href="https://github.com/rgrove/selleck/">GitHub repo</a>:
+Or clone the <a href="https://github.com/rgrove/selleck/">GitHub repo</a> to install the latest development version:
 </p>
 
-<pre class="terminal"><span class="noselect">$ </span>git clone git:&#x2F;&#x2F;github.com&#x2F;rgrove&#x2F;selleck.git</pre>
+<pre class="terminal"><span class="noselect">$ </span>git clone git:&#x2F;&#x2F;github.com&#x2F;rgrove&#x2F;selleck.git
+<span class="noselect">$ </span>cd selleck &amp;&amp; npm install -g</pre>
 
 
 <h2 id="overview">Overview</h2>
@@ -110,7 +114,7 @@ <h5 id="componentjson-sample"><code>component.json</code> sample</h5>
     &quot;description&quot;: &quot;Provides automatic input completion or suggestions for text input fields and textareas.&quot;,
     &quot;author&quot;     : &quot;rgrove&quot;,
 
-    &quot;tags&quot;: [&quot;widget&quot;, &quot;beta&quot;, &quot;autocomplete&quot;],
+    &quot;tags&quot;: [&quot;widget&quot;, &quot;autocomplete&quot;],
     &quot;use&quot; : [&quot;autocomplete&quot;]
 }</pre>
 
@@ -420,7 +424,8 @@ <h2 id="license">License</h2>
         </div>
 
         <div id="sidebar" class="yui3-u">
-                            <div id="toc" class="sidebox">
+
+                <div id="toc" class="sidebox">
                     <div class="hd">
                         <h2 class="no-toc">Table of Contents</h2>
                     </div>
@@ -484,7 +489,10 @@ <h2 class="no-toc">Table of Contents</h2>
 </ul>
                     </div>
                 </div>
-            </div>
+
+
+
+        </div>
     </div>
 </div>
 

diff --git a/docs/raw/index.mustache b/docs/raw/index.mustache
@@ -17,15 +17,16 @@ Install Selleck using npm:
 </p>
 
 ```terminal
-$ npm install selleck
+$ npm install selleck -g
 ```
 
 <p>
-Or just clone the <a href="https://github.com/rgrove/selleck/">GitHub repo</a>:
+Or clone the <a href="https://github.com/rgrove/selleck/">GitHub repo</a> to install the latest development version:
 </p>
 
 ```terminal
 $ git clone git://github.com/rgrove/selleck.git
+$ cd selleck && npm install -g
 ```
 
 <h2>Overview</h2>
@@ -96,7 +97,7 @@ Project metadata files must contain a `projectName` property, and component meta
     "description": "Provides automatic input completion or suggestions for text input fields and textareas.",
     "author"     : "rgrove",
 
-    "tags": ["widget", "beta", "autocomplete"],
+    "tags": ["widget", "autocomplete"],
     "use" : ["autocomplete"]
 }
 ```