diff --git a/README.md b/README.md index 476ecdcb6..855c4bd4b 100644 --- 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)