From 5e78777fdb9e584e9a050b74fc03e17dbbdb5779 Mon Sep 17 00:00:00 2001
From: Dan Barber <github@danbarber.me>
Date: Sun, 10 May 2015 15:13:16 +0100
Subject: [PATCH] Add readme.

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3615a7a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+Table Tennis Score Board
+=======================
+
+Implements a table tennis scoreboard which can be updated by PUTing to
+particular URL's. This was part of a hack day project that involved buttons
+hooked up to an [ESP-01](http://esp8266.co.uk/shop/esp-01) module programmed to
+hit the REST end points to update the scores.
+
+Games are automatically updated when a player wins (score hits at least 11 and
+is a clear 2 point lead). Players automatically switch sides between games.
+
+The back end is Sinatra and the front end is powered by Riot.js. Redis is used
+for data persistence. Pusher is used for communication between the back end and
+the front.
+
+Instructions
+------------
+
+Install the bundle:
+
+```sh
+$ bundle install
+```
+
+Run the server:
+
+```sh
+$ bundle exec foreman start
+```