Make doc index more useful.

1 files changed, 40 insertions, 4 deletions

diff --git a/docs/index.rst b/docs/index.rst
index 0c3a6e7..1fcf5f0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,7 +6,45 @@
 Welcome to Python StatsD's documentation!
 =========================================
 
-Contents:
+statsd_ is a friendly front-end to Graphite_. This is a Python client for the
+statsd daemon.
+
+Quickly, to use::
+
+    >>> import statsd
+    >>> c = statsd.StatsClient('localhost', 8125)
+    >>> c.incr('foo')  # Increment the 'foo' counter.
+    >>> c.timing('stats.timed', 320)  # Record a 320ms 'stats.timed'.
+
+You can also add a prefix to all your stats::
+
+    >>> import statsd
+    >>> c = statsd.StatsClient('localhost', 8125, prefix='foo')
+    >>> c.incr('bar')  # Will be 'foo.bar' in statsd/graphite.
+
+
+Installing
+----------
+
+The easiest way to install statsd is with pip!
+
+You can install from PyPI::
+
+    $ pip install statsd
+
+Or GitHub::
+
+    $ pip install -e git+https://github.com/jsocol/pystatsd#egg=statsd
+
+Or from source::
+
+    $ git clone https://github.com/jsocol/pystatsd
+    $ cd statsd
+    $ python setup.py install
+
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
@@ -18,9 +56,7 @@ Contents:
 
 
 Indices and tables
-==================
+------------------
 
-* :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`