From 7bb3f5e04271872972553cfb29a5526e607191cf Mon Sep 17 00:00:00 2001
From: bas080 <bas080@hotmail.com>
Date: Fri, 13 Feb 2015 01:54:35 +0100
Subject: [PATCH] Documentation update

- Very minimal API documentation. The code should be self explanatory.

- LICENSE information.
---
 LICENSE.md |  4 ++++
 README.md  | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 LICENSE.md
 create mode 100644 README.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..fb67788
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,4 @@
+License
+=======
+- Code	WTFPL
+- Texture	CC
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8840a74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Vines
+
+## Features
+- Rope block for spawning rope that slowly drops into the deep.
+- Vines are climbable and slowly grow downward.
+- Shears that allow the collecting of vines.
+- Spawns vines on jungletree leaves.
+- Roots on the bottom of dirt and dirt with grass nodes.
+- Spawns vines on trees located in swampy area.
+- Jungle vines that spawn on the side of jungletrees
+
+## API
+The API is very minimal. It allows the registering of vines.
+
+There are two types of vines. One that spawns at the bottom of nodes and uses the
+plantlike drawtype, and vines that spawn on the side that use signlike
+drawtype.
+
+### Example
+*taken from mod*
+
+```lua
+  vines.register_vine( 'vine', {
+    description = "Vines",
+    is_side_vine = false,
+    average_length = 9
+  }, biome )
+```
+
+|key|           type|  description|
+|---|           ---|   ---|
+|description|   string|The node tooltip description|
+|is_side_vine|  bool|  If not a side vine it is a plantlike drawtype bottom vine|
+|average_length|int|   The average length of vines|
+|biome|         table| A plants_lib biome format (see plants_lib documentation)|
+
+## Notice
+Vines use after_destruct on registered leave nodes to remove vines from which
+the leaves are removed. This is done by using the override function.
+Malfunctions may occur if other mods override the after_destruct of these nodes
+also.