From 878e45bf8c5a07ee4ee7fe657e617feabecd55c3 Mon Sep 17 00:00:00 2001
From: EmmaKnijn <64010592+EmmaKnijn@users.noreply.github.com>
Date: Mon, 8 Aug 2022 17:10:13 +0200
Subject: [PATCH 1/2] Fix require file names

The default install script offered in docs\home\installer.md would install to the file `basalt.lua` instead of `Basalt.lua`, directly following instructions would cause the example script to error because of this.
---
 docs/home/Quick-Start.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/home/Quick-Start.md b/docs/home/Quick-Start.md
index 36375c0..583344e 100644
--- a/docs/home/Quick-Start.md
+++ b/docs/home/Quick-Start.md
@@ -2,7 +2,7 @@
 
 To load the framework into your project, make use of the following code on top of your code.
 ```lua
-local basalt = require("Basalt")
+local basalt = require("basalt")
 ```
 
 It does not matter if you have installed the single file version or the full folder project. <br>
@@ -43,7 +43,7 @@ The true keyword in the end is optional and would simply start BPM immediately.
 Here is a fully functioning example of Basalt code
 
 ```lua
-local basalt = require("Basalt") --> Load the Basalt framework
+local basalt = require("basalt") --> Load the Basalt framework
 
 --> Create the first frame. Please note that Basalt needs at least one active "non-parent" frame to properly supply events
 --> When Basalt#createFrame makes use of unique identifiers (commonly referred to as UIDs), meaning that the supplied value must be UNIQUE
@@ -76,7 +76,7 @@ basalt.autoUpdate() --> Basalt#autoUpdate starts the event listener to detect us
 ```
 If you're like us and strive for succinct and beautiful code, here is a cleaner implementation of the code above:
 ```lua
-local basalt = require("Basalt")
+local basalt = require("basalt")
 
 local mainFrame = basalt.createFrame("mainFrame"):show()
 local button = mainFrame --> Basalt returns an instance of the object on most methods, to make use of "call-chaining"
-- 
2.49.1


From 039782ec0e94a0451d0f469f99775a5dc3267e0b Mon Sep 17 00:00:00 2001
From: EmmaKnijn <64010592+EmmaKnijn@users.noreply.github.com>
Date: Mon, 8 Aug 2022 17:12:18 +0200
Subject: [PATCH 2/2] Add clarification

IDs for all objects were recently changed to be optional, but this was not reflected in the example script
---
 docs/home/Quick-Start.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/home/Quick-Start.md b/docs/home/Quick-Start.md
index 583344e..5002627 100644
--- a/docs/home/Quick-Start.md
+++ b/docs/home/Quick-Start.md
@@ -47,7 +47,6 @@ local basalt = require("basalt") --> Load the Basalt framework
 
 --> Create the first frame. Please note that Basalt needs at least one active "non-parent" frame to properly supply events
 --> When Basalt#createFrame makes use of unique identifiers (commonly referred to as UIDs), meaning that the supplied value must be UNIQUE
---> If the supplied UID is ambiguous, Basalt#createFrame returns a nil value
 local mainFrame = basalt.createFrame("mainFrame")
 
 --> Show the frame to the user
-- 
2.49.1