Clean up docs (#388)

Author: bachya

AUTHORS.md

@@ -1,35 +1,53 @@
 # 🚨 simplisafe-python: A Python3, async interface to the SimpliSafe™ API
 
-[![CI](https://github.com/bachya/simplisafe-python/workflows/CI/badge.svg)](https://github.com/bachya/simplisafe-python/actions)
-[![PyPi](https://img.shields.io/pypi/v/simplisafe-python.svg)](https://pypi.python.org/pypi/simplisafe-python)
-[![Version](https://img.shields.io/pypi/pyversions/simplisafe-python.svg)](https://pypi.python.org/pypi/simplisafe-python)
-[![License](https://img.shields.io/pypi/l/simplisafe-python.svg)](https://github.com/bachya/simplisafe-python/blob/main/LICENSE)
-[![Code Coverage](https://codecov.io/gh/bachya/simplisafe-python/branch/dev/graph/badge.svg)](https://codecov.io/gh/bachya/simplisafe-python)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f46d8b1dcfde6a2f683d/maintainability)](https://codeclimate.com/github/bachya/simplisafe-python/maintainability)
-[![Say Thanks](https://img.shields.io/badge/SayThanks-!-1EAEDB.svg)](https://saythanks.io/to/bachya)
+[![CI][ci-badge]][ci]
+[![PyPI][pypi-badge]][pypi]
+[![Version][version-badge]][version]
+[![License][license-badge]][license]
+[![Code Coverage][codecov-badge]][codecov]
+[![Maintainability][maintainability-badge]][maintainability]
 
 <a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
 
 `simplisafe-python` (hereafter referred to as `simplipy`) is a Python3,
-`asyncio`-driven interface to the unofficial SimpliSafe™ API. With it, users can
-get data on their system (including available sensors), set the system state,
+`asyncio`-driven interface to the unofficial [SimpliSafe™][simplisafe] API. With it,
+users can get data on their system (including available sensors), set the system state,
 and more.
 
 # Documentation
 
-You can find complete documentation here: https://simplisafe-python.readthedocs.io
+You can find complete documentation [here][docs].
 
 # Contributing
 
-1. [Check for open features/bugs](https://github.com/bachya/simplisafe-python/issues)
-   or [initiate a discussion on one](https://github.com/bachya/simplisafe-python/issues/new).
-2. [Fork the repository](https://github.com/bachya/simplisafe-python/fork).
+Thanks to all of [our contributors][contributors] so far!
+
+1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
+2. [Fork the repository][fork].
 3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
 4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
 5. Install the dev environment: `script/setup`
-6. Code your new feature or bug fix.
+6. Code your new feature or bug fix on a new branch.
 7. Write tests that cover your new functionality.
-8. Run tests and ensure 100% code coverage: `poetry run pytest --cov simplipy tests`
+8. Run tests and ensure 100% code coverage: `poetry run pytest --cov simplisafe-python tests`
 9. Update `README.md` with any new documentation.
-10. Add yourself to `AUTHORS.md`.
-11. Submit a pull request!
+10. Submit a pull request!
+
+[ci-badge]: https://github.com/bachya/simplisafe-python/workflows/CI/badge.svg
+[ci]: https://github.com/bachya/simplisafe-python/actions
+[codecov-badge]: https://codecov.io/gh/bachya/simplisafe-python/branch/dev/graph/badge.svg
+[codecov]: https://codecov.io/gh/bachya/simplisafe-python
+[contributors]: https://github.com/bachya/simplisafe-python/graphs/contributors
+[docs]: https://simplisafe-python.readthedocs.io
+[fork]: https://github.com/bachya/simplisafe-python/fork
+[issues]: https://github.com/bachya/simplisafe-python/issues
+[license-badge]: https://img.shields.io/pypi/l/simplisafe-python.svg
+[license]: https://github.com/bachya/simplisafe-python/blob/main/LICENSE
+[maintainability-badge]: https://api.codeclimate.com/v1/badges/f46d8b1dcfde6a2f683d/maintainability
+[maintainability]: https://codeclimate.com/github/bachya/simplisafe-python/maintainability
+[new-issue]: https://github.com/bachya/simplisafe-python/issues/new
+[pypi-badge]: https://img.shields.io/pypi/v/simplisafe-python.svg
+[pypi]: https://pypi.python.org/pypi/simplisafe-python
+[simplisafe]: https://simplisafe.com
+[version-badge]: https://img.shields.io/pypi/pyversions/simplisafe-python.svg
+[version]: https://pypi.python.org/pypi/simplisafe-python

README.md

@@ -1,17 +1,5 @@
-% simplisafe-python documentation master file, created by
-% sphinx-quickstart on Sat Nov 16 14:00:49 2019.
-% You can adapt this file completely to your liking, but it should at least
-% contain the root `toctree` directive.
-
 # simplisafe-python
 
-`{image} https://github.com/bachya/simplisafe-python/workflows/CI/badge.svg`
-`{image} https://img.shields.io/pypi/v/simplisafe-python.svg`
-`{image} https://img.shields.io/pypi/pyversions/simplisafe-python.svg`
-`{image} https://img.shields.io/pypi/l/simplisafe-python.svg`
-`{image} https://codecov.io/gh/bachya/simplisafe-python/branch/main/graph/badge.svg`
-`{image} https://api.codeclimate.com/v1/badges/f46d8b1dcfde6a2f683d/maintainability`
-
 `simplisafe-python` (hereafter referred to as `simplipy`) is a Python3,
 `asyncio`-driven interface to the unofficial SimpliSafe™ API. With it, users can
 get data on their system (including available sensors), set the system state,
@@ -29,7 +17,3 @@ camera
 websocket
 api
 ```
-
-- {ref}`genindex`
-- {ref}`modindex`
-- {ref}`search`

docs/index.md

@@ -9,5 +9,6 @@ and more.
 working at any time without warning.
 
 **SPECIAL THANKS:** Original inspiration was obtained from
-<https://github.com/greencoder/easysafe-python>; thanks to Scott Newman for all the
-hard work!
+[`easysafe-python`][easysafe-python]; thanks to Scott Newman for all the hard work!
+
+[easysafe-python]: https://github.com/greencoder/easysafe-python

docs/intro.md

@@ -16,12 +16,9 @@ pip install simplisafe-python
 
 ## SimpliSafe™ Plans
 
-SimpliSafe™ offers several [monitoring plans](https://support.simplisafe.com/hc/en-us/articles/360023809972-What-are-the-service-plan-options-).
-Only the **Standard** and **Interactive** plans work with this library.
-
-Please note that only Interactive plans can access sensor values and set the system
-state; using the API with a Standard plan will be limited to retrieving the current
-system state.
+SimpliSafe™ offers several [monitoring plans][simplisafe-plans]. To date,
+`simplisafe-python` is known to work with all plans; if you should find differently,
+please consider submitting an [issue][simplisafe-python-issues].
 
 ## Accessing the API
 
@@ -208,3 +205,6 @@ However, should you need to refresh an access token manually at runtime, you can
 **It is vitally important not to let these tokens leave your control.** If
 exposed, savvy attackers could use them to view and alter your system's state. **You
 have been warned; proper storage/usage of tokens is solely your responsibility.**
+
+[simplisafe-plans]: https://support.simplisafe.com/hc/en-us/articles/360023809972-What-are-the-service-plan-options-
+[simplisafe-python-issues]: https://github.com/bachya/simplisafe-python/issues