Merge pull request 'docs(readme): setup readme file' (#12) from QN-4 into main

README.md

@@ -1,3 +1,72 @@
 # QNet
 
 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
+
+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
+
+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
+
+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.