diff options
| -rw-r--r-- | README.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md index f6b9473..9308246 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # circus-scoreboard -Scoreboard displaying the rankings of all companions in the swarm \ No newline at end of file +Scoreboard displaying the rankings of all companions in the swarm + +## Function + +This container displays a scoreboard ranking the individual companion +containers. The container should simply get a list of all running containers +using the docker socket (this is just an idea) and access a stats endpoint. The +stats endpoint optimally exposes the name of the user the companion container +belongs to and the amount of points the user has. |
