Add link for pre-commit to the readme

[hackapet/Adafruit_Blinka_Displayio.git] / README.rst

diff --git a/README.rst b/README.rst
index 5ce0090bfcfccb4c14367f2b283594da16fea1b9..4338cae5666ac6089b6066d699286dd5ac2e43fe 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,16 +1,16 @@
 Introduction
 ============
 
-.. image:: https://readthedocs.org/projects/adafruit-blinka-circuitpython-displayio/badge/?version=latest
-    :target: https://circuitpython.readthedocs.io/projects/displayio/en/latest/
+.. image:: https://readthedocs.org/projects/adafruit-blinka-displayio/badge/?version=latest
+    :target: https://adafruit-blinka-displayio.readthedocs.io/en/latest/
     :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://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/workflows/Build%20CI/badge.svg
-    :target: https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/actions
+.. image:: https://github.com/adafruit/Adafruit_Blinka_Displayio/workflows/Build%20CI/badge.svg
+    :target: https://github.com/adafruit/Adafruit_Blinka_Displayio/actions
     :alt: Build Status
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
@@ -24,32 +24,23 @@ Dependencies
 =============
 This driver depends on:
 
-* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
-
-Please ensure all dependencies are available on the CircuitPython filesystem.
-This is easily achieved by downloading
-`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
+* `Adafruit Blinka <https://github.com/adafruit/Adafruit_Blinka>`_
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-displayio/>`_. To install for current user:
+PyPI <https://pypi.org/project/adafruit-blinka-displayio/>`_. To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-displayio
+    pip3 install adafruit-blinka-displayio
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-displayio
+    sudo pip3 install adafruit-blinka-displayio
 
 To install in a virtual environment in your current project:
 
@@ -58,12 +49,7 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-displayio
-
-Usage Example
-=============
-
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+    pip3 install adafruit-blinka-displayio
 
 Contributing
 ============
@@ -72,6 +58,8 @@ Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
+To make sure your pull request will pass the commit checks, use pre-commit to check your code formatting. Please see the guide page here for more details: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github/check-your-code
+
 Documentation
 =============