From 5f150f4f5d07f55d7fe8cf81d2b3fb63d4450f77 Mon Sep 17 00:00:00 2001
From: Mineplay <tristanfranssen@strawhats.nl>
Date: Thu, 22 Jan 2026 20:38:23 +0100
Subject: [PATCH 1/5] docs(readme): added headers to readme

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5a81d2a..9ebe3b6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 # QNet
 
-QNet is a opensource networking library for both windows and linux written in c.
\ No newline at end of file
+QNet is a opensource networking library for both windows and linux written in c.
+
+## Introduction
+
+## Features
+
+## Installation
+
+### Prerequisites
+
+### Build steps
+
+## Using the library
\ No newline at end of file

From 68fc15306ffe135a633e1d7f904f79fef08ca463 Mon Sep 17 00:00:00 2001
From: Mineplay <tristanfranssen@strawhats.nl>
Date: Thu, 22 Jan 2026 20:43:58 +0100
Subject: [PATCH 2/5] docs(readme): added introduction to readme

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

diff --git a/README.md b/README.md
index 9ebe3b6..126e240 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ QNet is a opensource networking library for both windows and linux written in c.
 
 ## Introduction
 
+QNet is a opensource networking library for C that works both on windows an linux. The library aims to provide a tool for developing servers and clients that is easy to use and fast. Using async methods like epoll, iocp and threading this library allows for many fast connections between server and clients.
+
 ## Features
 
 ## Installation

From 00b3573421b3f96a158bdfec6a47372210b5bcb8 Mon Sep 17 00:00:00 2001
From: Mineplay <tristanfranssen@strawhats.nl>
Date: Thu, 22 Jan 2026 20:46:54 +0100
Subject: [PATCH 3/5] docs(readme): added features to readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 126e240..f409ae9 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,14 @@ QNet is a opensource networking library for C that works both on windows an linu
 
 ## Features
 
+The QNet library offers the following features:
+
+* TCP and UDP client
+* TCP and UDP server
+* Async request and response  processing
+* HTTP 1.1 request and response parsing
+* JSON parsing
+
 ## Installation
 
 ### Prerequisites

From f664ea73e7d5a9210e7ffe8c29002251a8a554a8 Mon Sep 17 00:00:00 2001
From: Mineplay <tristanfranssen@strawhats.nl>
Date: Thu, 22 Jan 2026 22:24:46 +0100
Subject: [PATCH 4/5] docs(readme): added installation guide to readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index f409ae9..1a7edaa 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,49 @@ The QNet library offers the following features:
 
 ### Prerequisites
 
+Ensure you have the following installed on your system:
+
+* CMake (minimum version 3.10)
+* A compatible C compiler (e.g., GCC or MSVC)
+
 ### Build steps
 
+1. Clone the repository:
+
+    ```bash
+    git clone https://repo.strawhats.nl/Mineplay/QNet.git
+    ```
+
+2. Navigate to the directory:
+
+    ```bash
+    cd QNet
+    ```
+
+3. Create build directory:
+    
+    ```bash
+    mkdir build
+    ```
+
+4. Run cmake to configure the project:
+    
+    ```bash
+    cmake . -B build
+    ```
+
+5. Build the project:
+    
+    ```bash
+    cmake --build build --config Release
+    ```
+    
+    To build in debug use:
+
+    ```bash
+    cmake --build build
+    ```
+
+    This will both generate the library and test files.
+
 ## Using the library
\ No newline at end of file

From 827c93608c105db5fd79ee99b9cd7bc657ff4552 Mon Sep 17 00:00:00 2001
From: Mineplay <tristanfranssen@strawhats.nl>
Date: Thu, 22 Jan 2026 22:27:06 +0100
Subject: [PATCH 5/5] docs(readme): added using library to readme

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1a7edaa..28b0f9f 100644
--- a/README.md
+++ b/README.md
@@ -65,4 +65,8 @@ Ensure you have the following installed on your system:
 
     This will both generate the library and test files.
 
-## Using the library
\ No newline at end of file
+## Using the library
+
+The library file can be found in the ./build/Release folder as qnet.lib for windows and in ./build folder as libqnet.a for linux. To use the library file you will need to copy the qnet folder containing the header files and follow the setup process for a library in the build system you are using.
+
+For more info about how to use the library see the documentation folder named docs.
\ No newline at end of file