From 22eeb943dfa5ad2b4d4feba1cf100248db1d9514 Mon Sep 17 00:00:00 2001
From: Azreyo <58790873+Azreyo@users.noreply.github.com>
Date: Sat, 8 Feb 2025 23:26:10 +0100
Subject: [PATCH] Update README.md

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 64 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6b41365..2e8b60e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,64 @@
-# Http-server
-Http server socket made in C 
+# HTTP Server
+
+This is a simple HTTP server for linux operating system written in C. It supports basic HTTP requests, logging, etc.
+
+## Features
+
+*   Handles GET requests for static files.
+*   Supports a control menu for managing server status, logging, and configuration (currently basic).
+*   Uses pthreads for concurrent client handling.
+*   Includes basic logging functionality with timestamps.
+*   Configuration is loaded from a JSON file (`server.json`).
+
+## Build Instructions
+
+1.  **Prerequisites:**
+    *   GCC compiler
+    *   Make (recommended)
+    *   OpenSSL libraries (`libssl`, `libcrypto`)
+    *   pthreads library
+    *   cJSON library
+
+2.  **Clone the repository (optional):**
+
+    ```bash
+    git clone https://github.com/Azreyo/Http-server  
+    cd Http-server       
+    ```
+
+3.  **Compile:**
+
+    ```bash
+    make
+    ```
+
+    This command will use the provided `Makefile` to compile the source files, link the necessary libraries, and create the executable in the `bin` directory.
+
+4.  **Create `www` directory:**
+
+    ```bash
+    mkdir www
+    ```
+
+    Place your HTML files (e.g., `index.html`) inside the `www` directory.
+
+5.  **Create `server.json`:**
+
+    Create a `server.json` file in the same directory as the executable with the following structure:
+
+    ```json
+    {
+      "port": 8080,
+      "use_https": false,
+      "log_file": "server.log",
+      "max_threads": 4,
+      "running": true
+    }
+    ```
+
+    Adjust the values as needed.  `use_https` is not yet implemented.
+
+## Run Instructions
+
+```bash
+./bin/server  # Run the executable from the bin directory