From 6fceab331ecbcefa3e1045e186a6f6d868d3f8af Mon Sep 17 00:00:00 2001 From: Tim Richardson Date: Thu, 20 Aug 2020 21:37:36 +0100 Subject: [PATCH] Improved README.md --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6c5ba28..734336e 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,17 @@ -# Strip Library +# The PixelPi Library for the WS281x Controller Board for the Raspberry Pi -This Strip Library is a fork of the Pimoroni (http://pimoroni.com) Plasma code (https://github.com/pimoroni/plasma), massively simplified and extensively modified to be used with the Strip Raspberry Pi 'small' HAT from Hut 8 Designs. +The PixelPi is a HAT-like add on board from Hut 8 Designs for the Raspberry Pi computer (40-pin versions) and enables +you to control up to four (4) WS281x type RGB LED strips or matrices independently with one Raspberry Pi. -## Compatible Products -. The Strip From Hut 8 Designs +![The PixelPi in action!](docs/source/images/pixelpi.jpg) +*The PixelPi in action!* -## Installing - -The library has been designed to only work with Python 3. - -```bash -cd ~ -git clone http://github.com/geekytim/PixelPiLibrary -cd ~/PixelPiLibrary -sudo bash install.sh -``` - -Disable audio... +This library is a fork of the Pimoroni (http://pimoroni.com) Plasma code (https://github.com/pimoroni/plasma), massively +simplified and extensively modified to be used with the Raspberry Pi PixelPi 'small' HAT. ## Documentation & Support -* Guides and tutorials - -* Function reference - -* Get help - +* Guides and tutorials - https://pixelpi.readthedocs.io/en/latest/ +* Function reference - https://pixelpi.readthedocs.io/en/latest/library.html +* Get help -