docs

README.md

@@ -4,7 +4,7 @@ Roblox Luau implementation of Separating Axis Theorem
 
 ## Install Using Wally
 
-"satutil = "mattmarcin/satutil@0.1.2"
+"satutil = "mattmarcin/satutil@0.2.0"
 
 ## Install Manually
 
@@ -16,4 +16,6 @@ Require the Module and then pass in 2 Models.
 
 SATUtil.ModelsCollide(model1, model2)
 
+Returns true if the bounding boxes intersect.
+
 The parameters must be Roblox Models.

init.lua

@@ -1,10 +1,12 @@
 -- Separating Axis Theorem (SAT) collision detection for Roblox
 -- by @mattmarcin
 -- Pass in 2 Models to ModelsCollide to test if they intersect. Supports rotation.
+-- This gets the BoundingBox of the model which encompasses the model and all of its children.
+-- A major benefit to this is being able to detect collisions between models that are not parented to the Workspace
 
 local SATUtil = {}
 
--- Test if two bounding boxes intersect. Return true if they do.
+-- Test if two Models intersect. Return true if they do.
 
 function SATUtil.ModelsCollide(object1: Model, object2: Model)
 	local box1CFrame, box1Size = object1:GetBoundingBox()