Updated readme.md

README.md

@@ -1 +1,50 @@
-protoc --go_out=plugins=grpc:proto proto/main.proto
+# grpc-game-example
+
+An example game built using Go, gRPC, and tview.
+
+The blog post for this project is a good reference: https://mortenson.coffee/blog/making-multiplayer-game-go-and-grpc
+
+I built this as a way to learn more about Go and haven't been using the
+language for that long so don't judge the code too harshly!
+
+## Game description
+
+The game is "tshooter", an offline or multiplayer shooter you play on your
+terminal. You move with the arrow keys and shoot lasers with the WASD keys.
+When a player gets 10 kills, the round ends and a new round begins. Bots and a
+maximum of eight players are supported
+
+## Reference and use
+
+Here's a quick reference for common operations on the project:
+
+```bash
+# Download go module dependencies
+go mod download
+# Build binaries
+make build
+# Run a local, offline game
+make run
+# Run a server with defaults
+make run-server
+# Run a client
+make run-client
+# Run a bot as a client
+make run-bot-client
+# Rebuild protobuf
+make proto
+# Run gofmt
+make fmt
+```
+
+If you run the commands or binaries directly more command line options are
+available:
+
+```bash
+# Run a server
+go run cmd/server.go -port=9999 -bots=2 -password=foo
+# Run a local, offline game
+go run cmd/client_local.go -bots=2
+# Run a bot as a client
+go run cmd/bot_client.go -address=":9999"
+```