From 46363150d07a480e4b2391ea13fb2d733462a825 Mon Sep 17 00:00:00 2001
From: Michel Fedde <35878897+Neintonine@users.noreply.github.com>
Date: Mon, 29 Jan 2024 21:33:39 +0100
Subject: [PATCH] Adds readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c493838
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Blender - Bake ID Mask Plugin
+
+A plugin to quickly bake ID masks for meshes from/to different sources and targets.
+
+### Currently supported:
+Sources:
+- Material Index
+
+Targets:
+- Vertex Color
+
+## Installation
+1. Download the newest file from the releases tab.
+2. Go to your blender preferences
+3. In Add-Ons, click on the "Install..." button and navigate to the downloaded file.
+4. After selecting it, just enable it and done.
+
+## Usage
+You find the tool in the panel on the right of the "3D Viewport" under "Tool".
+![Panel Location](docu/images/panel.png)
+
+How to use properly it, highly depends on the selected source.
+
+### Usage - Material Index Source
+Here the IDs are given based on the object and its material indices.
+
+Lets say, you have 10 objects and each has 2 materials attached to it. Then the amount of IDs given is 20, since each object contains the two material indecies.