Skip to content

Commit cfd053c

Browse files
committed
Fix TODOs in README
1 parent 3c98b1e commit cfd053c

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,14 @@ This is easily achieved by downloading
3838
or individual libraries can be installed using
3939
`circup <https://github.com/adafruit/circup>`_.
4040

41-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
42-
image from the assets folder in the PCB's GitHub repo.
41+
This library is intended to work with the MAX17048 or MAX17049 battery fuel gauge
42+
Python/CircuitPython library.
4343

4444
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5580>`_
4545

4646

4747
Installing from PyPI
4848
=====================
49-
.. note:: This library is not available on PyPI yet. Install documentation is included
50-
as a standard element. Stay tuned for PyPI availability!
51-
52-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
5349

5450
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5551
PyPI <https://pypi.org/project/adafruit-circuitpython-max1704x/>`_.
@@ -102,8 +98,7 @@ Or the following command to update an existing version:
10298
Usage Example
10399
=============
104100

105-
.. todo:: Add a quick, simple example. It and other examples should live in the
106-
examples folder and be included in docs/examples.rst.
101+
See usage examples of this library in the ``examples/`` folder.
107102

108103
Documentation
109104
=============

0 commit comments

Comments
 (0)