Added license and readme.

2 files changed, 45 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c11fdc0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2013 Kevin Chabowski
+
+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.markdown b/README.markdown
new file mode 100644
index 0000000..3404f41
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,27 @@
+# gomcmap
+
+A library for reading and modifying Minecraft maps.
+
+## Install
+
+	go get github.com/kch42/gomcmap/mcmap
+
+## Examples
+
+See `mcmap/examples`
+
+## Compatibility
+
+Currently only the Anvil map format is supported. Tested with Minecraft 1.6.2, will probably work with older versions too, but I haven't tested it.
+
+## WARNING
+
+Although I tested the library with some maps, I can't guarantee that everything always works (especially if you use mods in your Minecraft installation). So make a backup of your maps, just in case!
+
+## Wishlist / TODO
+
+* Adding / removing chunks.
+* Recalculating light data.
+* Recalculating height map.
+* Reading and modifying level.dat and other files (currently only the region files are used).
+* Test compatibility with older versions of Minecraft.