From 9d8ff5a25d3a5f3c3e2e41de66b05f760bee5bf6 Mon Sep 17 00:00:00 2001 From: Emile Date: Sun, 6 Oct 2019 15:44:30 +0200 Subject: added some sentences describing the function of the container --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.md') 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. -- cgit 1.4.1