add quick example to README

electrovir · Apr 4, 2022 · 820e444 · 820e444
1 parent 8cb3590
commit 820e444
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,13 @@ Hardware wise, this uses [Pin 12 aka BCM 18](https://pinout.xyz/pinout/pin12_gpi
 
 I found that my 32x8 LED matrix can be fully driven at _very high brightness_ by the Raspberry Pi's 5v power pin: No external power supply is needed for the LEDs.
 
+# Quick test
+
+1. Clone this repo
+2. CD to it
+3. run `npm install`
+4. run `npm run example`
+
 # Sudo
 
 Root access is required to access the Raspberry Pi's lower levels and draw to the matrix.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "ws2812draw",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "description": "Draw to a ws2812 LED matrix with a Raspberry Pi",
     "keywords": [
         "ws2812",