From 9b8a48c61b5ddf540c14bc15bd929105bc5f77b4 Mon Sep 17 00:00:00 2001
From: Adham Salama <adham.salama@wuilt.com>
Date: Mon, 17 Apr 2023 15:26:01 +0200
Subject: [PATCH] Update README

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6c059da..50d5799 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,30 @@
 # Sider
 
-An attemp to implement Redis from scratch in Rust.
+A Multithreaded Redis clone written from scratch in Rust.
+
+## Build
+
+Sider doesn't have any external dependencies.
+You can either run it directly:
+
+```
+cargo run --release
+```
+
+Or you can build it and use -p to specify the port and -t to specify a conenction timeout in milliseconds.
+
+```
+cargo build -- release
+./target/debug/sider -p 3000 -t 10
+```
+
+## Install
+
+Sider is published on crates.io, you can install it using cargo.
+
+```
+cargo install sider
+```
 
 ## Implemented commands (so far):
 
@@ -13,3 +37,23 @@ An attemp to implement Redis from scratch in Rust.
 - INCRBY
 - DECR
 - DECRBY
+
+## Benchmarks
+
+On my machine which has an i5-9300H Intel CPU.
+
+```
+redis-benchmark -n 100000 -c 100 -t set,get
+
+SET: 42844.90 requests per second
+GET: 43840.42 requests per second
+```
+
+```
+redis-benchmark -n 500000 -c 1000 -t set,get
+
+SET: 40041.64 requests per second
+GET: 40650.41 requests per second
+```
+
+Performance may vary depending on the machine you run the benchmarks on.