From cc0b0485f6b418c2e8126bdad951e01054bcb902 Mon Sep 17 00:00:00 2001 From: jbion Date: Thu, 9 Feb 2017 15:56:09 +0100 Subject: Update readme with work in progress status information --- README.md | 41 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 36 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c81a5d63..4e5fb31e 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,41 @@ [![Travis Build](https://img.shields.io/travis/luxons/seven-wonders/master.svg)](https://travis-ci.org/luxons/seven-wonders) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/luxons/seven-wonders/blob/master/LICENSE) -A digital version of the famous 7 Wonders board game. +A digital version of the famous [7 Wonders board game](https://en.wikipedia.org/wiki/7_Wonders_(board_game)). -We do not own the rights on the 7 Wonders game concept and rules, nor on the assets used here. +## Work in progress -A very early (staging) version of the app is running [here on heroku](https://seven-wonders-online.herokuapp.com/). -It is of course still under development and not usable yet. Also, it is very unstable as it is a staging server where - the app is redeployed after every successful build of the master branch. \ No newline at end of file +A very early (staging) version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/). +It is of course still under development and not usable yet because the development of the client just started. +Also, it is very unstable as it is a staging server where the app is redeployed after every successful build of the +master branch. + +### Server + +The websocket server API handles most of the game steps: +- Define your username +- Create / Join a game +- View joined lobby +- Start game +- View your hand and the table +- Make moves / See other's moves + +Missing steps: +- End of game event +- Access scoring + +### Client + +The client is just at the start of the development. It handles: +- Username choice +- Create / Join a game + +Missing steps: +- View joined lobby +- Start game +- Whole game process +- Scoring + +## Disclaimer + +We do not own the rights on the 7 Wonders game concept and rules, nor on the assets used here. \ No newline at end of file -- cgit