Skip to content
Browse files

started to add documentation

  • Loading branch information...
1 parent 68176d5 commit da177a09c89a69c5268033897f79623e7bbc0737 @VanCoding committed Mar 21, 2013
Showing with 14 additions and 2 deletions.
  1. +14 −2 readme.md
View
16 readme.md
@@ -3,8 +3,20 @@ A node.js module to read/write from/to region files of Minecraft.
##API Docs
-coming soon
+###Loading the module
+
+ var MCAManager = require("mca.js");
+
+###Constructor
+
+ var m = new MCAManager("/path/to/minecraft/world/region/r.0.0.mca");
+
+###Methods
+
+- **open( cb )**
+- **init( cb )**
+- **close( cb )**
##License
-GPL
+GPL

0 comments on commit da177a0

Please sign in to comment.
Something went wrong with that request. Please try again.