From 1df5e4b4d0a46000c50a829624cbb8ad2e121d8f Mon Sep 17 00:00:00 2001
From: Akashdeep Dhar <akashdeep.dhar@gmail.com>
Date: Dec 16 2020 12:04:47 +0000
Subject: Added note, features and contribute sections


---

diff --git a/README.md b/README.md
index 245869d..eca099e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# supervisor-driver-service
-Reference driver endpoint service written in Falcon, Werkzeug and Psutil
+<p align="center">
+  <img width="15%" src="https://github.com/t0xic0der/supervisor-frontend-service/blob/initial-documentation/pictures/mainicon.svg" />
+</p>
+
+<h1 align="center">SuperVisor</h1>
+<h3 align="center">Driver Service</h3>
+<p align="center">Reference driver endpoint service written in Falcon, Werkzeug and Psutil</p>
+
+<p align="center">
+    <img src="https://img.shields.io/github/issues/t0xic0der/supervisor-driver-service?style=flat-square&logo=appveyor&color=teal">
+    <img src="https://img.shields.io/github/forks/t0xic0der/supervisor-driver-service?style=flat-square&logo=appveyor&color=teal">
+    <img src="https://img.shields.io/github/stars/t0xic0der/supervisor-driver-service?style=flat-square&logo=appveyor&color=teal">
+    <img src="https://img.shields.io/github/license/t0xic0der/supervisor-driver-service?style=flat-square&logo=appveyor&color=teal">
+    <img src="https://img.shields.io/github/watchers/t0xic0der/supervisor-driver-service?style=flat-square&color=teal&logo=appveyor">
+</p>
+
+## Note
+This project works as an intuitive remotely accessible system performance monitoring and task management service for servers and headless Raspberry Pi setups, 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
+- 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
+- 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
+
+## 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: