Update README.md

README.md

@@ -1,2 +1,34 @@
-# KSP-DepthMask
-a plugin for creating hollow spaces in KSP
+# ModuleDepthMask
+---
+
+This plugin allows for parts to have hollow insets that dont clip into other parts, ideal for engine nozzles, landing gear, air intakes, solar panel bays, and more. It is a standalone version of the depth mask module included in the [Restock](github.com/PorktoberRevolution/ReStocked) dll, which will be included in the next major Restock update along with the additon of depth masks to several stock parts
+
+### Usage
+1. Add a depth mask mesh to your part model. It should cover up the hollow area you want to prevent clipping in, without sticking out.
+2. Mark the depth mask object with the `Icon_Hidden` tag to prevent it from showing in the VAB part picker
+3. Add a new `ModuleDepthMask` to your part config
+4. Add the name of your mask object in the `maskTransform` property
+5. (Optional) Add the name of the object you want to restrict the mask effect to in the `bodyTransform` property
+
+##### An example config:
+```
+  MODULE
+  {
+    name = ModuleDepthMask
+    maskTransform = mask
+    bodyTransform = interior //Optional
+  }
+```
+
+### Screenshots
+mask meshes and configs for these stock parts will be included in the next major update to Restock
+
+<a href="url"><img src="https://github.com/drewcassidy/KSP-DepthMask/raw/master/Screenshots/depthmask-jets.png"  height="300" ></a>
+<a href="url"><img src="https://github.com/drewcassidy/KSP-DepthMask/raw/master/Screenshots/depthmask-intake.png"  height="300" ></a>
+
+<a href="url"><img src="https://github.com/drewcassidy/KSP-DepthMask/raw/master/Screenshots/depthmask-box.png"  height="300" ></a>
+### Licensing
+This plugin is licensed Creative Commons Sharealike Attribution. This means that you can redistribute it and its source code however you like as long as you include attribution and indicate the changes you made, if any. 
+
+### Redistribution
+You are free to redistribute this plugin in your mods, or embed the code in your own plugins (with a different module name for compatability of course.) To prevent duplicates of the plugin, please add the dll to the root gamedata directory. In general, treat this mod the same as [Modulemanager](github.com/sarbian/ModuleManager) for redistribution