Skip to content

Commit f940a75

Browse files
author
Adam Patt
committed
fix readme
1 parent 4627711 commit f940a75

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Introduction
1313
:target: https://travis-ci.org/apatt/CircuitPython_LED_Animation
1414
:alt: Build Status
1515

16-
.. todo:: Describe what the library does.
16+
Perform a variety of LED animation tasks
1717

1818
Dependencies
1919
=============
@@ -28,7 +28,15 @@ This is easily achieved by downloading
2828
Usage Example
2929
=============
3030

31-
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
31+
import adafruit_dotstar as dotstar
32+
import board
33+
from led_animation import color
34+
# setup the pixel
35+
dot = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=.2)
36+
# set the color by name
37+
dot[0] = color.GOLD
38+
# show the pixel
39+
dot.show()
3240

3341
Contributing
3442
============

0 commit comments

Comments
 (0)