From 51ca1fcefb9a5d2154083f7d27830fdde81cca1c Mon Sep 17 00:00:00 2001 From: qfx Date: Thu, 13 Feb 2020 20:51:06 +0200 Subject: [PATCH] readme --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 23cc6c4..9bcc69d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ -![alt text](https://i.imgur.com/2i2MS2l.png "Helium") +![alt text](https://i.imgur.com/ZQBQfsa.png "Helium") # Helium - ## user facing functions + ## Major features: + ### Custom elements + Write your own elements, and interface with them however you want to + ### Efficient rendering & updating + The elements only update&re-render when state changes + ### Code hotswap + Save a file, and see changes immediately + ## User facing interface ```lua -Element(function,reloader,w,h,parameters) --Creates a new element - :draw(x,y) --Renders the element at a location - :undraw() --Removes the element from the render buffer +helium.element(function,reloader,w,h,parameters) + ->Element --Creates a new element + :draw(x,y) --Renders the element at a location + :undraw() --Removes the element from the render buffer --The intended loader for element files (supports optional live hotswapping) HeliumLoader(filepath) -> ElementFactory -ElementFactory(w,h,parameters) -> Element +ElementFactory(parameters,w,h) -> Element -Input +helium.input .subscribe(x, y, w, h, subType, callback, startOn) subType -- Subscription type callback -- Subscription callback on event