Add link for pre-commit to the readme

[hackapet/Adafruit_Blinka_Displayio.git] / README.rst

diff --git a/README.rst b/README.rst
index dbaa736f13a76436958f4d125cd2143f9894992e..4338cae5666ac6089b6066d699286dd5ac2e43fe 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,16 +1,16 @@
 Introduction
 ============
 
-.. image:: https://readthedocs.org/projects/adafruit-blinka-blinka-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
@@ -58,7 +58,9 @@ 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
 =============
 
-For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-blinka-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.