From a1a80511c8ad20caa545a3c47f98f3e400f07846 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C4=B0shak=20G=C3=B6n=C3=BCl?=
 <76657662+shakg@users.noreply.github.com>
Date: Mon, 25 Sep 2023 19:43:31 +0300
Subject: [PATCH] Update README.md

---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 88 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8de99e2..741a1c9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,89 @@
-# g-systemctl
-graphical systemctl to manage services
+# G-Systemctl
 
+g-systemctl is a graphical user interface for your services in *nix systems. you can see all of your service deamons and search, filter them. 
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+- [API](#api)
+- [Frontend](#frontend)
+- [Contributing](#contributing)
+
+### Prerequisites
+
+- Go (Golang): [Install Go](https://golang.org/doc/install)
+- A web browser for frontend testing
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/yourusername/your-repo.git
+   cd your-repo
+   ```
+
+2. Build the project:
+
+   ```bash
+   go build server.go
+   ```
+
+## Usage
+
+```bash
+sudo chmod +x server
+```
+and 
+
+```bash
+./server <port>
+```
+<port> could be any free port in your system. For example 8080. 
+
+### Running the Server
+
+To start the server, run the executable or use `go run` with the following command:
+
+```bash
+./server <port>
+# or
+go run server.go <port>
+```
+
+Replace `<port>` with the desired port number (e.g., 8080).
+
+The server will be accessible at `http://localhost:<port>`.
+
+## API
+
+The API provides information about the running system's status.
+
+- **Endpoint:** `/api`
+- **Method:** `GET`
+
+Example response:
+
+> TODO : Change this to correct output. 
+```json
+{
+  "service_1": "active",
+  "service_2": "inactive",
+  ...
+}
+```
+
+## Frontend
+
+The frontend of this project consists of vanilla HTML and JavaScript. The frontend files are served at the root path ("/").
+
+- **HTML File:** `index.html`
+- **JavaScript File:** `app.js`
+
+You can access the frontend at `http://localhost:<port>`.
+
+## Contributing
+
+Contributions are welcome! Please follow the [Contributing Guidelines](CONTRIBUTING.md) for details on how to contribute to this project.