Merge pull request #7 from omrisarig13/master

Fix misleading examples in README
pimoroni · Sep 15, 2021 · 3309f83 · 3309f83
2 parents 8e32f40 + 46880d2
commit 3309f83
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -49,3 +49,11 @@ lights.set_pixel(2, 0, 0, 255)  # Pixel 3 to Blue
 ```
 
 Pixels are zero-indexed and accept Red, Green and Blue colour values from 0 to 255.
+
+To set the lights, after the colours were set as wanted, use the `show` method:
+
+```python
+lights.show()
+```
+
+Without the `show` method, only the internal data is updated, the lights changes only after this function call.
diff --git a/library/README.md b/library/README.md
@@ -50,6 +50,14 @@ lights.set_pixel(2, 0, 0, 255)  # Pixel 3 to Blue
 
 Pixels are zero-indexed and accept Red, Green and Blue colour values from 0 to 255.
 
+To set the lights, after the colours were set as wanted, use the `show` method:
+
+```python
+lights.show()
+```
+
+Without the `show` method, only the internal data is updated, the lights changes only after this function call.
+
 # Changelog
 
 0.0.3