summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorChris Erickson <chris-erickson@users.noreply.github.com>2015-06-20 15:09:50 -0500
committerChris Erickson <chris-erickson@users.noreply.github.com>2015-06-20 15:09:50 -0500
commitbb80b3e779168cdb93295b44c73c44444153c66d (patch)
tree2aa3fb77b63b1036ad65efed5761ad0649bf5e8c /README.rst
parentf204d426bd4c364e80c6b59b27a12aaf48d6bb23 (diff)
downloadpy-bcrypt-git-bb80b3e779168cdb93295b44c73c44444153c66d.tar.gz
Update README to include additional install steps
This was helpfully pointed out in https://github.com/pyca/bcrypt/issues/41
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 1fa3bbd..0e3b128 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
bcrypt
======
-.. image:: https://pypip.in/version/bcrypt/badge.svg?style=flat
+.. image:: https://img.shields.io/pypi/v/nine.svg
:target: https://pypi.python.org/pypi/bcrypt/
:alt: Latest Version
@@ -20,6 +20,19 @@ To install bcrypt, simply:
$ pip install bcrypt
+Note that bcrypt should build very easily on Linux provided you have a C compiler, headers for Python (if you’re not using pypy), and headers for the libffi libraries available on your system.
+
+For Debian and Ubuntu, the following command will ensure that the required dependencies are installed:
+
+.. code:: bash
+
+ $ sudo apt-get install build-essential libssl-dev libffi-dev python-dev
+
+For Fedora and RHEL-derivatives, the following command will ensure that the required dependencies are installed:
+
+.. code:: bash
+
+ $ sudo yum install gcc libffi-devel python-devel openssl-devel
Usage
-----