X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka.git/blobdiff_plain/8b62f3a78019d9f575618fd342be960b40e3a900..bb0f4840e3448a5020a83efedf4453c17b792799:/README.rst

diff --git a/README.rst b/README.rst
index 07266d7..40df1a9 100755
--- a/README.rst
+++ b/README.rst
@@ -6,13 +6,17 @@ Introduction
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
-    :target: https://discord.gg/nBQh6qu
+    :target: https://adafru.it/discord
     :alt: Discord
 
 .. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master
     :target: https://travis-ci.com/adafruit/Adafruit_Blinka
     :alt: Build Status
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code Style: Black
+
 This repository contains a selection of packages mirroring the CircuitPython API
 on hosts running micropython. Working code exists to emulate the CircuitPython packages;
 
@@ -22,8 +26,10 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
 * **bitbangio** - software-driven interfaces for I2C, SPI
 * **busio** - hardware-driven interfaces for I2C, SPI, UART
-* **time** * - substitute functions monkey-patched to time module
+* **pulseio** - contains classes that provide access to basic pulse IO (PWM)
 
+For details, see the `Blinka API reference
+<https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.
 
 Dependencies
 =============
@@ -35,6 +41,31 @@ CircuitPython image, they have no value on a device already running CircuitPytho
 The test suites in the test/src folder under **testing.universal** are by design
 intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance.
 
+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-Blinka/>`_. To install for current user:
+
+.. code-block:: shell
+
+    pip3 install Adafruit-Blinka
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install Adafruit-Blinka
+
+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-Blinka
+
 Usage Example
 =============
 
@@ -48,7 +79,6 @@ the following sequence runs through some basic testing of the digitalio compatib
 
 An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
 
-
 Contributing
 ============
 
@@ -69,7 +99,7 @@ install dependencies (feel free to reuse the virtual environment from above):
 
     python3 -m venv .env
     source .env/bin/activate
-    pip install Sphinx sphinx-rtd-theme
+    pip install Sphinx sphinx-rtd-theme Adafruit-PlatformDetect
 
 Now, once you have the virtual environment activated: