aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2017-02-16 19:43:32 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2017-02-16 19:43:32 +0100
commit4e611c3d77496aa8ac7d08ec71fbc05abfffab32 (patch)
tree468d2483ecc64b91b436d11c35003dface3e5bdc
parentccdc8abe087b5b1a7dcd1c3fb1fec2203f36274c (diff)
downloadgoffel-4e611c3d77496aa8ac7d08ec71fbc05abfffab32.tar.gz
goffel-4e611c3d77496aa8ac7d08ec71fbc05abfffab32.zip
README: add netcat example
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index e76aeb5..1568a58 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,19 @@ Goffel has a command line utility to start the various game interfaces.
will present the available options.
+A game on a goffel server instance can be played simply through netcat.
+
+```
+> netcat muhq.space 63036
+HELO test
+test
+h
+```
+
+The above example connects to the goffel server running at muhq.space.
+It registers a player, named "test", joins the session "test" and outputs a help
+message.
+
An example how to use goffel's library can be found in uis/interactive.go.
It implements a simple terminal based yahtzee game.