From b8f1090b74bc929e0562903d15603005e2504444 Mon Sep 17 00:00:00 2001
From: Patryk Hegenberg <patrykhegenberg@gmail.com>
Date: Fri, 19 Apr 2024 12:50:43 +0200
Subject: [PATCH] docs: added README file

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d831ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# Caesar
+This program provides a simple relay server that can be controlled via the command line.
+## Prerequisites
+Rust toolchain installed
+## Installation
+1. Clone the repository:
+  ```bash
+  git clone https://github.com/your-username/caesar.git
+  ```
+2. Change to the project directory:
+  ```bash
+  cd caesar
+  ```
+3. Build the program:
+```bash
+cargo build --release
+```
+
+## Usage
+The program offers the following commands:
+`serve`
+Starts the relay server.
+```bash
+./target/release/caesar serve
+```
+
+You can optionally specify the listening address and port using flags:
+```bash
+./target/release/caesar serve -p 8080 -l 192.168.1.100
+```
+By default, the server listens on 0.0.0.0:1323.
+
+`send`
+Sends data through the relay server.
+```bash
+./target/release/caesar send
+```
+
+`receive`
+Receives data through the relay server.
+```bash
+./target/release/caesar receive
+```
+
+## Help
+For more information about the commands and arguments, use:
+```bash
+./target/release/caesar --help
+```
+
+## Development
+To start a test system, please follow these steps:
+Start the relay server:
+```bash
+./target/release/caesar serve
+```
+
+Open a send window in another terminal:
+```bash
+./target/release/caesar send
+```
+
+Open a receive window in another terminal:
+```bash
+./target/release/caesar receive
+```
+
+Now you can test the functionality of the relay server.