add Readme

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e76aeb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# goffel - the golang Kniffel/Yahtzee implementation
+
+If you don't know what [Yahtzee](https://en.wikipedia.org/wiki/Yahtzee) is you don't
+need goffel.
+
+Goffel includes a library, which implements the game logic of Yahtzee,
+as well as some game implementations.
+
+## Installation
+
+To install goffel just run:
+
+```go get muhq.space/go/muhq/goffel```
+
+## Usage
+
+Goffel has a command line utility to start the various game interfaces.
+
+```goffel -h```
+
+will present the available options.
+
+An example how to use goffel's library can be found in uis/interactive.go.
+It implements a simple terminal based yahtzee game.
+