rfac: readme.md

README.md

@@ -1,3 +1,33 @@
 ![Logo](assets/autocd-logo.png)
-# autoCD is a platform to provide CD solutions in  a monolithic server
+
+# autoCD
+It is a platform to provide automation to CD in monolythic server.
+
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
+![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)
+![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
+![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)
+![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
+![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+
+# Features
+ - Maintain users
+ - Maintain users permissions
+ - Maintain projects
+ - Project CD script
+ - Message queue
+ - Autoscalling of threads 
+ - Application logs
+
+ # Quickstart
+
+ - Install java-17
+   (On ubuntu)
+
+   ```
+   apt-get update
+   apt-get upgrade
+   apt install openjdk-17-jdk openjdk-17-jre
+   ```