Merge pull request #6 from ericrasmussen/dhhagan-patch-1

README cleanup
ericrasmussen · Jul 3, 2014 · 7d1b8ac · 7d1b8ac
2 parents 261e3c8 + db31934
commit 7d1b8ac
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 88 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,2 @@
-include README.markdown
 include README.rst
 include CHANGES.txt
diff --git a/README.markdown b/README.markdown
diff --git a/README.rst b/README.rst
@@ -14,6 +14,31 @@ Features
 4) Simple `Exceptions`
 
 
+Installation
+============
+
+You can install postmonkey via `easy_install`:
+
+.. code-block:: console
+
+    easy_install postmonkey
+
+Or by using `pip` (requires you to specify the version because latest is 1.0b):
+
+.. code-block:: console
+
+    pip install postmonkey==1.0b
+
+Or by placing the requirement in `install_requires` in your `setup.py` file:
+
+.. code-block:: python
+
+      install_requires=[
+          # all your other packages
+          'postmonkey==1.0b',
+      ]
+
+
 Basic Usage
 ===========