From 15f7db8adba89a31de1c1eb39ea2379d73b7fc6c Mon Sep 17 00:00:00 2001
From: Nightcycle <77173389+nightcycle@users.noreply.github.com>
Date: Tue, 23 Jul 2024 18:55:23 -0400
Subject: [PATCH] Create README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3875a27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+example usage:
+```luau
+local character: Model
+local shirt: Shirt
+
+
+local clothingImage: EditableImage = Util.loadClothingImageAsync(shirt)
+-- modifying the source clothingImage is much faster than modifying the images post application
+
+Util.apply(character, clothingImage, Enum.BodyPartR15.RightUpperArm)
+Util.apply(character, clothingImage, Enum.BodyPartR15.RightLowerArm)
+Util.apply(character, clothingImage, Enum.BodyPartR15.RightHand)
+Util.apply(character, clothingImage, Enum.BodyPartR15.LeftUpperArm)
+Util.apply(character, clothingImage, Enum.BodyPartR15.LeftLowerArm)
+Util.apply(character, clothingImage, Enum.BodyPartR15.LeftHand)
+Util.apply(character, clothingImage, Enum.BodyPartR15.LowerTorso)
+
+-- if you want it to change while on the character, you need to use the applied EditableImage
+local upperTorsoImage: EditableImage? = Util.apply(character, clothingImage, Enum.BodyPartR15.UpperTorso)
+assert(upperTorsoImage)
+```