Complete Readme

Complete the todos of the Readme: - add links to decision log and API documentation - add links to the wiki - add overview of the achievements and trophies - add copyright notice for the badges, using a Creative Commons license Signed-off-by: ahahn94 <[email protected]>
The-Microservice-Dungeon · Jan 27, 2022 · 4258edd · 4258edd
1 parent 9095654
commit 4258edd
Showing 1 changed file with 45 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -28,16 +28,54 @@ This will compile the project and start the application.
 We configured a Grafana Dashboard for displaying game-related metrics and some score values. The 
 necessary configuration files are found in this repo as well ([Prometheus](./src/main/prometheus), [Grafana](./src/main/grafana)).
 
+## Documentation
 
-## Todo
-This README file should be adapted to include the following information:
+### Decision Log
+An overview of our decisions can be found [here](https://the-microservice-dungeon.github.io/decisionlog/services/gameLog.html) on the Microservice Dungeon Decision Log.
 
-(1) How can the service be started, regardless of the platform? A short, precise instruction is sufficient. Existence/familiarity with tools like maven can be assumed.
+### API Documentation
+Our API Documentation can be found [here(REST API)](https://raw.githubusercontent.com/The-Microservice-Dungeon/gamelog/main/docs/api-spec.yaml) and [here(Event Specification)](https://raw.githubusercontent.com/The-Microservice-Dungeon/gamelog/main/docs/event-spec.yaml).
 
-(2) What other prerequisites must be in place for the service to run? For example, linking to further documentation of required infrastructure such as Kafka from the DevOps team.
+### Wiki
+Further documentation can be found on the [wiki](https://github.com/The-Microservice-Dungeon/gamelog/wiki), including [Problems and Conclusions for further Development](https://github.com/The-Microservice-Dungeon/gamelog/wiki/Problems---Conclusions---Future-Development),
+the [Scoreboard Mechanics](https://github.com/The-Microservice-Dungeon/gamelog/wiki/Scoreboard-mechanics), the [Concept of the Service](https://github.com/The-Microservice-Dungeon/gamelog/wiki/Service) and the list of [Trophies and Achievements](https://github.com/The-Microservice-Dungeon/gamelog/wiki/Trophies).
 
-(3) Are there decisions from the decision log that should be further elaborated (like domain model)? Depending on the level of detail, describe in more detail here or in the wiki.
+## Features
+This microservice provides scoreboards and trophies for the players of the Microservice Dungeon.
 
-(4) Are there further links that promote navigation or understanding? For example, link to API documentation or important decisions in the decision log.
+### Scoreboard
+The service provides a scoreboard for the total scores of the players. Whoever ranks no. 1 on this board can be considered the winner of the game.
 
-_Note_: The design of the task planning and review is up to the team. One possible option is to use a Kanban board directly via GitHub.
+The service also provides categorized scoreboards in 4 categories to enable competing in different aspects of the game. Those categories are:
+- Fighting
+- Mining
+- Trading
+- Traveling
+
+### Achievements and Trophies
+
+The service provides achievements and trophies.  
+Achievements are awarded for the individual progress of the player in activities of the game.  
+Trophies are awarded to the players that rank 1st, 2nd and 3rd on any of the scoreboards.
+
+#### Achievements
+
+| Category / Level | Bronze                                                                                                                                                                          | Silver                                                                                                                                                                           | Gold                                                                                                                                                                                 |
+|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|  
+| Fighting         | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Fighting%20Bronze%20-%20First%20Blood.png" width="250"> | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Fighting%20Silver%20-%20Blood%20Thirst.png" width="250"> | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Fighting%20Gold%20-%20Psychopath.png" width="250">           |  
+| Mining           | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Mining%20Bronze%20-%20Miner.png" width="250">           | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Mining%20Silver%20-%20Gold%20Digger.png" width="250">    | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Mining%20Gold%20-%20Mining%20Industrialist.png" width="250"> |  
+Trading          | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Trading%20Bronze%20-%20Businessman.png" width="250">    | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Trading%20Silver%20-%20Manager.png" width="250">         | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Trading%20Gold%20-%20Grand%20Nagus.png" width="250">         |  
+| Traveling        | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Traveling%20Bronze%20-%20Sputnik.png" width="250">      | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Traveling%20Silver%20-%20Apollo%2011.png" width="250">   | <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/achievements/Traveling%20Gold%20-%20Enterprise.png" width="250">          |    
+
+#### Trophies
+
+|Scoreboard / Rank|Third Place|Second Place|First Place|  
+|---------------|-|-|-|  
+|Game| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Game%20Score%20-%20Third%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Game%20Score%20-%20Second%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Game%20Score%20-%20First%20Place.png" width="250">       |  
+|Fighting| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Fighting%20Score%20-%20Third%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Fighting%20Score%20-%20Second%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Fighting%20Score%20-%20First%20Place.png" width="250">   |  
+|Mining| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Mining%20Score%20-%20Third%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Mining%20Score%20-%20Second%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Mining%20Score%20-%20First%20Place.png" width="250">     |  
+|Trading| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Trading%20Score%20-%20Third%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Trading%20Score%20-%20Second%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Trading%20Score%20-%20First%20Place.png" width="250">    |  
+|Traveling| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Traveling%20Score%20-%20Third%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Traveling%20Score%20-%20Second%20Place.png" width="250">| <img src="https://raw.githubusercontent.com/wiki/The-Microservice-Dungeon/gamelog/assets/pictures/trophies/scoreboard/Traveling%20Score%20-%20First%20Place.png" width="250">  |
+
+#### Copyright of the graphics
+Copyright (c) André Hahn, 2022. Licensed under the Terms and Conditions of the Creative Commons CC BY-NC license.