From 86b135371c5b5535682127b73e841509358b50b8 Mon Sep 17 00:00:00 2001 From: Georg Date: Tue, 27 Mar 2018 18:41:02 +0200 Subject: [PATCH] Better README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fab64fe..b2f3078 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ -This is the beerbox project, TODO: add better readme ;-) +# The Beerbox Project + +The Beerbox Project features a digital counter for drunken beer, or other drinks. +It consists of the hardware and the software part. + +To identify a user the Beerbox can ether use an RFID tag or a fingerprint. Once a user is identified it books the credits of the selected drink to him/her. The selected dirnk can be changed via the push of a button. + +TODO: build intructions & hardware documentation