Skip to content

Commit 8845ef1

Browse files
authored
Update README.rst
1 parent 7d668f2 commit 8845ef1

File tree

1 file changed

+14
-28
lines changed

1 file changed

+14
-28
lines changed

README.rst

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,20 @@ Introduction
2222
:target: https://github.com/psf/black
2323
:alt: Code Style: Black
2424

25-
Drivers for various I2C GPIO expanders.
25+
Drivers for various I2C GPIO expanders. The library does not require any libraries other than the standard install of circuit python. Once the exapander has been initialized, the pins can be defined and interacted with in the same way as GPIOs on the CPU.
2626

27+
This library currently supports
28+
29+
* PCA9555
30+
* PCAL9555
31+
* PCA9554
32+
* PCAL9554
33+
* PCA9538
34+
* PCAL9538
35+
36+
Other expanders will likely be added over time as I use them.
37+
38+
Based on Adafruit's library for the `MCP230xx expanders <https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx>`_
2739

2840
Dependencies
2941
=============
@@ -43,31 +55,6 @@ Installing from PyPI
4355
.. note:: This library is not available on PyPI yet. Install documentation is included
4456
as a standard element. Stay tuned for PyPI availability!
4557

46-
.. note:: TODO: Remove the above note if PyPI version is/will be available at time of release.
47-
48-
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
49-
PyPI <https://pypi.org/project/circuitpython-i2c-expanders/>`_.
50-
To install for current user:
51-
52-
.. code-block:: shell
53-
54-
pip3 install circuitpython-i2c-expanders
55-
56-
To install system-wide (this may be required in some cases):
57-
58-
.. code-block:: shell
59-
60-
sudo pip3 install circuitpython-i2c-expanders
61-
62-
To install in a virtual environment in your current project:
63-
64-
.. code-block:: shell
65-
66-
mkdir project-name && cd project-name
67-
python3 -m venv .venv
68-
source .env/bin/activate
69-
pip3 install circuitpython-i2c-expanders
70-
7158
Installing to a Connected CircuitPython Device with Circup
7259
==========================================================
7360

@@ -93,8 +80,7 @@ Or the following command to update an existing version:
9380
9481
Usage Example
9582
=============
96-
97-
.. note:: TODO: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
83+
Take a look in the examples folder for a basic example of using this library.
9884

9985
Documentation
10086
=============

0 commit comments

Comments
 (0)