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