From 7126c611b92e6e01461b1bc0b1f04c5236407f8d Mon Sep 17 00:00:00 2001
From: Ruslan Spivak <ruslan.spivak@gmail.com>
Date: Mon, 9 May 2011 01:44:52 -0400
Subject: [PATCH] Updated documentation

---
 README.rst                               | 50 +++++++++++++++++++++---
 docs-source/_templates/sidebarintro.html |  2 +-
 docs-source/index.rst                    | 49 +++++++++++++++++++++--
 3 files changed, 90 insertions(+), 11 deletions(-)

diff --git a/README.rst b/README.rst
index 7e26233..52f030d 100644
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,48 @@
 Welcome to SlimIt
 ==================================
 
-`SlimIt` is a Python library that parses JavaScript and returns AST.
-
-At version `0.2` it includes a JavaScript parser, lexer, pretty
-printer and a tree visitor.
-
+`SlimIt` is a JavaScript minifier written in Python.
+It compiles JavaScript into more compact code so that it downloads
+and runs faster.
+
+`SlimIt` also provides a library that includes a JavaScript parser,
+lexer, pretty printer and a tree visitor.
+
+Let's minify some code
+----------------------
+
+From the command line:
+
+$ slimit -h
+Usage: slimit [input file]
+
+If no input file is provided STDIN is used by default.
+Minified JavaScript code is printed to STDOUT.
+
+$ cat test.js
+var a = function( obj ) {
+        for ( var name in obj ) {
+                return false;
+        }
+        return true;
+};
+$
+$ slimit < test.js
+var a=function(obj){for(var name in obj){return false;}return true;};
+
+Or using library API:
+
+>>> from slimit import minify
+>>> text = """
+... var a = function( obj ) {
+...         for ( var name in obj ) {
+...                 return false;
+...         }
+...         return true;
+... };
+... """
+>>> print minify(text)
+var a=function(obj){for(var name in obj){return false;}return true;};
 
 Iterate over, modify a JavaScript AST and pretty print it
 ---------------------------------------------------------
@@ -81,4 +118,5 @@ Using ``easy_install``::
 
 Roadmap
 -------
-- Add JavaScript minification
+- More minifications
+
diff --git a/docs-source/_templates/sidebarintro.html b/docs-source/_templates/sidebarintro.html
index 6242778..b72bf0f 100644
--- a/docs-source/_templates/sidebarintro.html
+++ b/docs-source/_templates/sidebarintro.html
@@ -1,6 +1,6 @@
 <h3>About SlimIt</h3>
 <p>
-  SlimIt is a Python library that parses JavaScript and returns AST
+  SlimIt is a JavaScript minifier
 </p>
 <h3>Useful Links</h3>
 <ul>
diff --git a/docs-source/index.rst b/docs-source/index.rst
index 6b6d4f8..a3b56e6 100644
--- a/docs-source/index.rst
+++ b/docs-source/index.rst
@@ -6,11 +6,52 @@
 Welcome to SlimIt
 ==================================
 
-`SlimIt` is a Python library that parses JavaScript and returns AST.
+`SlimIt` is a JavaScript minifier written in Python.
+It compiles JavaScript into more compact code so that it downloads
+and runs faster.
 
-At version `0.2` it includes a JavaScript parser, lexer, pretty
-printer and a tree visitor.
+`SlimIt` also provides a library that includes a JavaScript parser,
+lexer, pretty printer and a tree visitor.
 
+Let's minify some code
+----------------------
+
+From the command line:
+
+.. code-block:: bash
+
+    $ slimit -h
+    Usage: slimit [input file]
+
+    If no input file is provided STDIN is used by default.
+    Minified JavaScript code is printed to STDOUT.
+
+    $ cat test.js
+    var a = function( obj ) {
+            for ( var name in obj ) {
+                    return false;
+            }
+            return true;
+    };
+    $
+    $ slimit < test.js
+    var a=function(obj){for(var name in obj){return false;}return true;};
+
+Or using library API:
+
+.. code-block:: python
+
+    >>> from slimit import minify
+    >>> text = """
+    ... var a = function( obj ) {
+    ...         for ( var name in obj ) {
+    ...                 return false;
+    ...         }
+    ...         return true;
+    ... };
+    ... """
+    >>> print minify(text)
+    var a=function(obj){for(var name in obj){return false;}return true;};
 
 Iterate over, modify a JavaScript AST and pretty print it
 ---------------------------------------------------------
@@ -87,7 +128,7 @@ Using ``easy_install``::
 
 Roadmap
 -------
-- Add JavaScript minification
+- More minifications
 
 .. toctree::
    :maxdepth: 2