From 2ee5d4403991b09927c3f26023dd33b983d00658 Mon Sep 17 00:00:00 2001 From: Michael Bang Date: Sat, 11 Apr 2015 19:13:30 +0200 Subject: [PATCH] Update readme. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3f8284..97dfe2d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ -This is a very simple minecraft (and source engine?) RCON client. See [cli/main.go](cli/main.go) for an example on how to use it. +# Introduction +This is a very simple, synchronous Minecraft and Minecraft Pocket Edition (Minecraft PE, Pocketmine) RCON client, implemented to [these specs](http://wiki.vg/Rcon). + + +[cli/main.go](cli/main.go) implements a REPL CLI as an example of how to use the client. # Shortcomings -- Long (split) responses aren't handled correctly. +- Synchronous. +- Long (split) responses from server aren't handled correctly. - Probably a lot more.