Skip to content

Commit bcedf6a

Browse files
committed
update readme
1 parent bfe28d0 commit bcedf6a

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,10 @@ or individual libraries can be installed using
3838
`circup <https://github.com/adafruit/circup>`_.
3939

4040

41-
42-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
43-
image from the assets folder in the PCB's GitHub repo.
44-
45-
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
41+
`Fruit Jam will be available from the Adafruit shop <http://www.adafruit.com/products/>`_
4642

4743
Installing from PyPI
4844
=====================
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.
5345

5446
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
5547
PyPI <https://pypi.org/project/adafruit-circuitpython-fruitjam/>`_.
@@ -100,8 +92,16 @@ Or the following command to update an existing version:
10092
Usage Example
10193
=============
10294

103-
.. todo:: Add a quick, simple example. It and other examples should live in the
104-
examples folder and be included in docs/examples.rst.
95+
.. code-block:: python
96+
97+
import supervisor
98+
99+
from adafruit_fruitjam.peripherals import request_display_config
100+
101+
print(f"Display is None ? {supervisor.runtime.display is None}")
102+
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
103+
request_display_config(360, 200)
104+
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
105105
106106
Documentation
107107
=============

0 commit comments

Comments
 (0)