From d354da99d84ddae1a466bc4ade4d13f4c3039d59 Mon Sep 17 00:00:00 2001
From: Edouard DUPIN <yui.heero@gmail.com>
Date: Thu, 29 Dec 2022 10:08:36 +0100
Subject: [PATCH] [DEV] initial commit

---
 readme.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5917f06
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,40 @@
+Karanage
+========
+
+**K**angaroo **A**nd **R**abbit (m)anage is a simple interface to manage system status.
+
+  - for CPU check
+  - for Memory check
+  - for swap check
+  - for drive check
+  - for network check
+  - for docker check
+
+
+Run and install:
+================
+
+so simple...
+
+```{.bash}
+# start the Bdd interface (no big data > 50Mo)
+cd bdd
+docker-compose up -d
+# start the REST API
+cd back
+docker-compose up -d
+# start the front API
+cd ../front
+docker-compose up -d
+```
+
+build the local image:
+
+docker pull archlinux:base-devel
+docker pull bellsoft/liberica-openjdk-alpine:latest
+
+docker build -t gitea.atria-soft.org/kangaroo-and-rabbit/karanage:latest .
+
+docker login gitea.atria-soft.org
+
+docker push gitea.atria-soft.org/kangaroo-and-rabbit/karanage:latest