Update README.rst
Some checks failed
Build CI / test (push) Has been cancelled

This commit is contained in:
Liz 2025-01-28 10:54:35 -05:00
parent 84037038b5
commit ac9822d550

View file

@ -37,19 +37,10 @@ This is easily achieved by downloading
or individual libraries can be installed using or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_. `circup <https://github.com/adafruit/circup>`_.
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
image from the assets folder in the PCB's GitHub repo.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5832>`_ `Purchase one from the Adafruit shop <http://www.adafruit.com/products/5832>`_
Installing from PyPI 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.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ina228/>`_. PyPI <https://pypi.org/project/adafruit-circuitpython-ina228/>`_.
@ -100,8 +91,8 @@ Or the following command to update an existing version:
Usage Example Usage Example
============= =============
.. todo:: Add a quick, simple example. It and other examples should live in the .. code-block:: python
examples folder and be included in docs/examples.rst. import adafruit_ina228
Documentation Documentation
============= =============