Merge pull request #10 from adafruit/pypi-readme

update readme with PyPI install instructions
This commit is contained in:
Brennen Bearnes 2018-12-20 13:12:06 -07:00 committed by GitHub
commit 8d40ab80c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pn532/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pn532
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pn532
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-pn532
Usage Example
=============