Updated README

pimoroni · Nov 12, 2018 · 7459b24 · 7459b24
1 parent 39fd5c3
commit 7459b24
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![!](plasma-logo.png)
+# Plasma Arcade Lights
 
 [![Build Status](https://travis-ci.com/pimoroni/plasma.svg?branch=master)](https://travis-ci.com/pimoroni/plasma)
 [![Coverage Status](https://coveralls.io/repos/github/pimoroni/plasma/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/plasma?branch=master)

diff --git a/library/README.rst b/library/README.rst
@@ -1,5 +1,5 @@
-.. figure:: plasma-logo.png
-   :alt: Plasma Logo
+Plasma Arcade Lights
+====================
 
 |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
 
@@ -67,6 +67,24 @@ other environments:
 
     sudo pip2 install plasmalights
 
+Using Plasma
+~~~~~~~~~~~~
+
+Plasma installs two programs onto your Raspberry Pi. ``plasma`` itself
+and a tool called ``plasmactl`` you can use to install and switch
+lighting effects. Plasma runs as a service on your system.
+
+``plasmactl`` commands:
+
+-  ``plasmactl 255 0 0`` - Set Plasma lights to R, G, B colour. Red in
+   this case.
+-  ``plasmactl <pattern>`` - Set Plasma lights to pattern image
+-  ``plasmactl fps <fps>`` - Change plasma effect framerate (default is
+   30, lower FPS = less CPU)
+-  ``plasmactl --list`` - List all available patterns
+-  ``sudo plasmactl --install <pattern>`` - Install a new pattern, where
+   ``<pattern>`` is the filename of a 24bit PNG image file
+
 Development:
 ~~~~~~~~~~~~