Update Readme and add license

jiminy-billy-bob · Nov 16, 2017 · 7e22d33 · 7e22d33
1 parent d37ae25
commit 7e22d33
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 1 deletion.
diff --git a/Examples/Green Prism.skp b/Examples/Green Prism.skp
diff --git a/Examples/ExampleTool.rb → Examples/example_tool.rb b/Examples/ExampleTool.rb → Examples/example_tool.rb
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2017 Julia Christina Eneroth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
-Shading
+# FaceShader
+
+This is an attempt to mimic SketchUp's own face shading to let custom Ruby Tools preview faces as if they have already been drawn.
+
+![](example.gif)
+
+(Example from Eneroth Align Face)
+
+To use this class in your own plugin projects, copy face_shader.rb into your plugin's directory and replace the outer wrapper module with the module your plugin uses.
diff --git a/example.gif b/example.gif
diff --git a/FaceShader.rb → face_shader.rb b/FaceShader.rb → face_shader.rb