From 330f01048c9519bb25615ac06dcafe6e0964319d Mon Sep 17 00:00:00 2001
From: Robert Jelic <36573031+NoryiE@users.noreply.github.com>
Date: Sat, 2 Apr 2022 17:00:35 +0200
Subject: [PATCH] Updated NyoUI (markdown)

---
 NyoUI.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)

diff --git a/NyoUI.md b/NyoUI.md
index 095e72c..462d0d8 100644
--- a/NyoUI.md
+++ b/NyoUI.md
@@ -6,3 +6,85 @@ To start using NyoUI you have to do the following line of code:
 
 remember you need the NyoUI.lua file on your computer!
 
+Now you are able to call all these functions:
+
+## NyoUI.createFrame
+create a frame without a parent
+````lua
+local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
+````
+**args:** the id as string<br>
+**returns:** frame object<br>
+
+## NyoUI.removeFrame
+removes the frame
+````lua
+local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
+NyoUI.removeFrame("myFirstFrame")
+````
+**args:** the id as string<br>
+**returns:**-<br>
+
+## NyoUI.getFrame
+With that function you can get frames, but only frames without a parent!
+````lua
+NyoUI.createFrame("myFirstFrame")
+NyoUI.getFrame("myFirstFrame"):show()
+````
+**args:** id of the frame<br>
+**returns:** frame object<br>
+
+## NyoUI.getActiveFrame
+returns the currently active (without a parent) frame
+````lua
+NyoUI.createFrame("myFirstFrame"):show()
+NyoUI.debug(NyoUI.getActiveFrame():getName()) -- returns myFirstFrame
+````
+**args:** -<br>
+**returns:** frame object<br>
+
+## NyoUI.startUpdate
+starts the logic, draw and event handler
+````lua
+local mainFrame = NyoUI.createFrame("myFirstFrame"):show()
+NyoUI.startUpdate()
+````
+**args:** -<br>
+**returns:**-<br>
+
+## NyoUI.stopUpdate
+stops the logic, draw and event handler
+````lua
+NyoUI.stopUpdate()
+````
+**args:** -<br>
+**returns:**-<br>
+
+## NyoUI.debug
+Something you just need as a developer, why shouldn't i publish it? This creates a label on the bottom left of your active frame, if you click on that label it will
+create a fully sized frame with a list, where it logs all your debug messages
+````lua
+NyoUI.debug("Hi i am cute")
+````
+**args:** ... (multiple args are possible, like print does<br>
+**returns:**-<br>
+
+# Additional informations
+## For beginners:
+If you are new to such things, you want to create your own logic (lets say for example a redstone or rednet handler) while using my UI Framework, you just have to create something like this:
+
+````lua
+local NyoUI = dofile("NyoUI.lua")
+
+local mainFrame = NyoUI.createFrame("mainFrame"):show()-- lets create a frame and a button without functionality
+mainFrame:addButton("aButton"):onClick(function() end):show()
+
+local function yourCustomHandler()
+    while true do
+        -- add your logic here
+        os.sleep(1) -- you need something which calls coroutine.yield(), yes os.sleep does that os.pullEvent() aswell
+    end
+end
+
+parallel.waitForAll(NyoUI.startUpdate, yourCustomHandler) -- here it will handle your function (yourCustomHandler) and NyoUIs handlers at the "almost same" time
+````
\ No newline at end of file