Merge pull request #9 from adafruit/cookiecutter

Made changes to bring library closer to cookiecutter

Author: dhalbert

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
+    rev: v2.11.1
     hooks:
     -   id: pylint
         name: pylint (library code)

README.rst

@@ -1,6 +1,22 @@
 Introduction
 ============
 
+.. image:: https://readthedocs.org/projects/adafruit-circuitpython-typing/badge/?version=latest
+    :target: https://docs.circuitpython.org/projects/typing/en/latest/
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://adafru.it/discord
+    :alt: Discord
+
+.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Typing/workflows/Build%20CI/badge.svg
+    :target: https://github.com/adafruit/Adafruit_CircuitPython_Typing/actions
+    :alt: Build Status
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code Style: Black
+
 Definitions not in the standard `typing` module that are
 needed for type annotation of CircuitPython code.
 

docs/examples.rst

@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/circuitpython_typing_simpletest.py
-    :caption: examples/circuitpython_typing_simpletest.py
+.. literalinclude:: ../examples/typing_simpletest.py
+    :caption: examples/typing_simpletest.py
     :linenos: