Add docs to README

noahhusby · Sep 16, 2024 · 03a40be · 03a40be
1 parent 2c0b68a
commit 03a40be
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,9 @@
 # aiostreammagic
 
 #### An async python package for interfacing with Cambridge Audio / Stream Magic compatible streamers
+
+[**📖 Read the docs »**][docs]
+
 [![GitHub Release][releases-shield]][releases]
 [![Python Versions][python-versions-shield]][pypi]
 [![Downloads][downloads-shield]][pypi]
@@ -97,6 +100,7 @@ if __name__ == '__main__':
 ```
 
 [license-shield]: https://img.shields.io/github/license/noahhusby/aiostreammagic.svg
+[docs]: https://noahhusby.github.io/aiostreammagic/
 [downloads-shield]: https://img.shields.io/pypi/dm/aiostreammagic
 [python-versions-shield]: https://img.shields.io/pypi/pyversions/aiostreammagic
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg