example code. fixing todos and docs things

Author: FoamyGuy

README.rst

@@ -36,16 +36,10 @@ This is easily achieved by downloading
 or individual libraries can be installed using
 `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.
+* `NeoPixel Products <https://www.adafruit.com/category/168>`_
 
-`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
 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
 PyPI <https://pypi.org/project/adafruit-circuitpython-pixelmap/>`_.
@@ -85,7 +79,7 @@ following command to install:
 
 .. code-block:: shell
 
-    circup install pixelmap
+    circup install adafruit_pixelmap
 
 Or the following command to update an existing version:
 
@@ -96,8 +90,37 @@ Or the following command to update an existing version:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the
-examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+    import board
+    import neopixel
+    import time
+    from adafruit_pixelmap import PixelMap, horizontal_strip_gridmap, vertical_strip_gridmap
+
+    # Update to match the pin connected to your NeoPixels
+    pixel_pin = board.NEOPIXEL
+
+    # Update to match the number of NeoPixels you have connected
+    pixel_num = 32
+
+    pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.1, auto_write=True)
+
+    pixel_wing_vertical = PixelMap.vertical_lines(
+        pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+    )
+    pixel_wing_horizontal = PixelMap.horizontal_lines(
+        pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+    )
+
+    for row in range(len(pixel_wing_horizontal)):
+        pixels.fill(0x00000)
+        pixel_wing_horizontal[row] = 0x00ff00
+        time.sleep(0.3)
+
+    for row in range(len(pixel_wing_vertical)):
+        pixels.fill(0x00000)
+        pixel_wing_vertical[row] = 0xff00ff
+        time.sleep(0.3)
 
 Documentation
 =============

docs/index.rst

@@ -24,14 +24,12 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    Led Animations Guide - Pixel Mapping <https://learn.adafruit.com/circuitpython-led-animations/pixel-mapping>
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    NeoPixel Products <https://www.adafruit.com/category/168>
 
 .. toctree::
     :caption: Other Links

examples/pixelmap_simpletest.py

@@ -1,4 +1,46 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-# SPDX-FileCopyrightText: Copyright (c) 2022 Tim Cocks for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
+# SPDX-FileCopyrightText: 2022 Tim Cocks for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+"""
+This example shows usage of the PixelMap helper to easily treat a single strip as a horizontal or
+vertical grid for animation purposes.
+
+For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using
+a different form of NeoPixels. Note that if you are using a number of pixels other than 32, you
+will need to alter the PixelMap values as well for this example to work.
+
+This example does not work on SAMD21 (M0) boards.
+"""
+import time
+import board
+import neopixel
+from adafruit_pixelmap import PixelMap, horizontal_strip_gridmap
+
+# board.NEOPIXEL is the pin on the NeoTrellis M4.
+# Update to match the pin that your neopixels are connected to.
+pixel_pin = board.NEOPIXEL
+
+# Update to match the number of NeoPixels you have connected
+pixel_num = 32
+
+pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.1, auto_write=True)
+
+pixel_wing_vertical = PixelMap.vertical_lines(
+    pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+)
+pixel_wing_horizontal = PixelMap.horizontal_lines(
+    pixels, 8, 4, horizontal_strip_gridmap(8, alternating=False)
+)
+
+for i, row in enumerate(pixel_wing_horizontal):
+    pixels.fill(0x00000)
+    pixel_wing_horizontal[i] = 0x00FF00
+    time.sleep(0.3)
+
+for i, col in enumerate(pixel_wing_vertical):
+    pixels.fill(0x00000)
+    pixel_wing_vertical[i] = 0xFF00FF
+    time.sleep(0.3)
+
+while True:
+    pass