From 45d65fd98e1b4086356f29d04d2e79dfb4dfd62e Mon Sep 17 00:00:00 2001 From: Akashdeep Dhar Date: Mar 03 2021 04:59:03 +0000 Subject: Added an animated GIF and removed features section Signed-off-by: Akashdeep Dhar --- diff --git a/README.md b/README.md index a6110a8..275e0c5 100644 --- a/README.md +++ b/README.md @@ -20,28 +20,18 @@ container station servers and headless Raspberry Pi setups where multiple contai require observation, with secure passcode-protected endpoints so that clients can connect via the [SuperVisor Frontend Service](https://github.com/t0xic0der/supervisor-frontend-service/) and manage their devices. -## Features -- Zero dependence on pre-rendered template with the use of **DeadSync** to render DOM elements on connection -- Efficient JSON data structure for 100% faster updating with the use of **LiveSync** to refresh DOM contents -- Intuitive endpoints for fetching preliminaries, statistics, logs and process listing for containers -- Intuitive endpoints for fetching preliminaries and revision histories for images -- Intuitive endpoints for fetching preliminaries for both networks and volumes -- Relatively low overhead from the server during live stat (approx. 2MB over Python 3 runtime usage) -- Live polling time period is left at client-side decision to stick to a simple client-server model -- Monitoring station information is provided by the awesome **`psutil`** library -- Monitoring and management Docker information is provided by the effective **`docker-py`** library -- Added protection using passcode verification parameter check and server-side authentication of data requests -- Decoupled structure allows for connection to frontend service ([Check here](https://github.com/t0xic0der/supervisor-frontend-service)) -- Authenticated process management endpoints - **`TERMINATE`**, **`KILL`**, **`SUSPEND`** and **`RESUME`** ops -- Rewritten entirely in Falcon WSGI and Werkzeug HTTP server to emphasise on speed, efficiency and cleaner code +## In action + +![](pictures/drivanim.gif) ## Table of contents 1. [Home](https://github.com/t0xic0der/supervisor-driver-service/wiki) 2. [Installation](https://github.com/t0xic0der/supervisor-driver-service/wiki/Installation) -3. [Download releases](https://github.com/t0xic0der/supervisor-driver-service/releases) +3. [Obtain releases](https://github.com/t0xic0der/supervisor-driver-service/releases) 4. [SuperVisor Frontend Service](https://github.com/t0xic0der/supervisor-frontend-service) ## Contribute -You may request for the addition of new features in the [issues](https://github.com/t0xic0der/supervisor-driver-service/issues) -page but as the project is singlehandedly maintained - it might take time to develop on them. Please consider forking -the repository and contributing to its development. :heart: +You may request for the addition of new features in the +[issues](https://github.com/t0xic0der/supervisor-driver-service/issues) page but as the project is singlehandedly +maintained - it might take time to develop on them. Please consider forking the repository and contributing to its +development. diff --git a/pictures/drivanim.gif b/pictures/drivanim.gif new file mode 100644 index 0000000..4036be8 Binary files /dev/null and b/pictures/drivanim.gif differ