From 01f378328e5383d05d52428b815f992eb2c536cb Mon Sep 17 00:00:00 2001
From: Will Daly <will@edx.org>
Date: Sun, 4 Jan 2015 12:23:10 -0500
Subject: Add Sphinx API docs

---
 docs/install.rst | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 docs/install.rst

(limited to 'docs/install.rst')

diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..1dd6d4e
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,79 @@
+Install
+=======
+
+Install with your favorite package manager
+
+Latest Release
+--------------
+Pip:
+
+.. code:: bash
+
+    pip install kafka-python
+
+Releases are also listed at https://github.com/mumrah/kafka-python/releases
+
+
+Bleeding-Edge
+-------------
+
+.. code:: bash
+
+    git clone https://github.com/mumrah/kafka-python
+    pip install ./kafka-python
+
+Setuptools:
+
+.. code:: bash
+
+    git clone https://github.com/mumrah/kafka-python
+    easy_install ./kafka-python
+
+Using `setup.py` directly:
+
+.. code:: bash
+
+    git clone https://github.com/mumrah/kafka-python
+    cd kafka-python
+    python setup.py install
+
+
+Optional Snappy install
+-----------------------
+
+Install Development Libraries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Download and build Snappy from http://code.google.com/p/snappy/downloads/list
+
+Ubuntu:
+
+.. code:: bash
+
+    apt-get install libsnappy-dev
+
+OSX:
+
+.. code:: bash
+
+    brew install snappy
+
+From Source:
+
+.. code:: bash
+
+    wget http://snappy.googlecode.com/files/snappy-1.0.5.tar.gz
+    tar xzvf snappy-1.0.5.tar.gz
+    cd snappy-1.0.5
+    ./configure
+    make
+    sudo make install
+
+Install Python Module
+^^^^^^^^^^^^^^^^^^^^^
+
+Install the `python-snappy` module
+
+.. code:: bash
+
+    pip install python-snappy
-- 
cgit v1.2.1