update documentation

flmichel · Jul 30, 2023 · ff792f4 · ff792f4
1 parent 403f712
commit ff792f4
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Architecture
+
+The gaming platform is composed of the different elements:
+
+1. A player
+2. A remote
+3. A [game](documentation/game.md)
+4. A server api
+5. A stun server
+
+![](documentation/diagram/context.svg)
diff --git a/documentation/diagram/component_game.svg b/documentation/diagram/component_game.svg
diff --git a/documentation/diagram/containers_definition.puml b/documentation/diagram/containers_definition.puml
@@ -12,7 +12,7 @@ Container(game, "Game", "Rust", "Game which runs on a computer (Linux, Mac OS X,
 Container(remote, "Remote", "JavaScript", "Web applicaiton accessed from a smartphone that is the remote for the game")
 !endprocedure
 !unquoted procedure server_api()
-Container(server_api, "Server API", "Rust", "Provides Internet banking functionality via API", $tags="backendContainer")
+Container(server_api, "Server API", "Rust", "Act as a Signaling server to enable connection between the Remote and the Game", $tags="backendContainer")
 !endprocedure
 !unquoted procedure stun()
 System_Ext(stun, "STUN Server", "The STUN server used to establish WebRTC connections")

diff --git a/documentation/diagram/context.svg b/documentation/diagram/context.svg
diff --git a/documentation/documentation.md b/documentation/documentation.md
@@ -3,9 +3,9 @@
 The gaming platform is composed of the different elements:
 
 1. A player
-2. A [remote](remote.md)
+2. A remote.md
 3. A [game](game.md)
-4. A [server api](server_api.md)
+4. A server_api.md
 5. A stun server
 
 ![](diagram/context.svg)