:memo: Update supportlib to explain new features

1 files changed, 63 insertions, 3 deletions

diff --git a/docs/Scripting/SupportLib/README.md b/docs/Scripting/SupportLib/README.md
index 92f69c4..c2c7a99 100644
--- a/docs/Scripting/SupportLib/README.md
+++ b/docs/Scripting/SupportLib/README.md
@@ -1,5 +1,65 @@
 # Support Library
 
+The script/mode file has to contain a `Main` class, which is inherited from `NeoBehaviour` like this:
+```python
+from luxcena_neo import NeoBehaviour
+
+class Main(NeoBehaviour):
+    def on_start(self):
+        strip.setPixelColor(0, "#fafafa")
+    
+```
+The `strip` will be available anywhere in your script whe it is started using `neo_runtime`.
+
+---
+
+## `class` NeoBehaviour
+This is the class your `Main` should inherit from.
+This has some special methods that you can override.
+
+*NOTE:* Do not override `__init__` unless you know
+what you are doing! This contains code that
+is crucial for `neo_runtime`.
+
+### def declare_variables(`self`)
+When the runtime executes this, the method `self.declare(Variable)` is available. This is where
+you can add variables that show up in the UI.
+Take a look at the `Variable` class further down on this site.
+
+### def on_start(`self`)
+This is run once at the start of the program. This is a logical place
+to initialize variables where you need to remember state, but you
+don't want to put the variable in the UI.
+
+### def each_tick(self):
+This will run as often as possible. If nothing else happens, it will run every one millisecond.
+
+### def each_second(self):
+This will run at most once a second, it might be longer if some other function is doing some work that takes a long time (more that a second).
+
+### def each_minute(self):
+This will run at most once a minute, it might be longer if some other function is doing some work that takes a long time (more that a minute).
+
+### def each_hour(self):
+This will run at most once a hour, it might be longer if some other function is doing some work that takes a long time (more that a hour).
+
+### def each_day(self):
+This will run at most once a day, it might be longer if some other function is doing some work that takes a long time (more that a day).
+
+### deltatime
+For each of the `each_` methods, you can add a second argument to the 
+definition. If you do, that will be the time in seconds since last time
+the function ran.
+```python
+def each_tick(self, dt):
+    print(dt)
+def each_minute(self, deltatime):
+    print(dt)
+```
+The name of the parameter doesn't matter. For the example above,
+in an ideal world, this would print `0.1` every millisecond, and `60` every minute. Because the world isnt ideal, the deltatime is likely
+going to be slightly longer than the ideal.
+
 ---
 
 ## `class` Strip
@@ -40,7 +100,7 @@ If parameter is a tuple, the first three items in that tuple will be treated as
 If parameter is a int, it will be treated as a 24-bit color value. e.g. `set_pixel_color(0, 2812873)`
 If there are 3 parameters, these will be treated as a rgb value. e.g. `set_pixel_color(0, 255, 238, 10)`
 This means that all of these have the same effect:
-```
+```python
 set_pixel_color(0, "#fafafa")
 set_pixel_color(0, 16448250)
 set_pixel_color(0, 250, 250, 250)
@@ -57,8 +117,8 @@ Convert provided hex color to a tuple with rgb colors. (r, g, b).
 ## utils.rgb_to_hex(`rgb`)
 Converts rgb colors in tuple to hex string.
 
-## utils.rgb_from_24bit(`color`)
+## utils.rgb_from_twentyfour_bit(`color`)
 Takes a 24bit color value and returns a rgb tuple.
 
-## utils.rgb_from_24bit(`color`)
+## utils.rgb_from_twentyfour_bit(`color`)
 Takes a 24bit color value and returns a hex string.