Made the README

cuberite · Aug 13, 2013 · ce761fa · ce761fa
1 parent 40094c2
commit ce761fa
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,20 @@
-transapi
+TransAPI
 ========
 
-A Translation API for MCServer
+A plugin translation API for MCServer.
+
+TransAPI is designed to be used with the provided client library, however there is also a stable API available for use.
+
+API
+---
+
+    GetLanguage ( cPlayer )
+    Returns the user's preferred language (or server default if not set). (ISO 639-1 language code)
+
+    GetConsoleLanguage ( )
+    Returns the preferred language for console text. (ISO 639-1 language code)
+
+Commands
+--------
+
+ * /language [lang] - Takes a language code (ISO 639-1) and sets the user's preferred language to that. (tranapi.setlang)