Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Adham Salama committed Apr 17, 2023
1 parent 6cffb20 commit 9b8a48c
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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):

Expand All @@ -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.

0 comments on commit 9b8a48c

Please sign in to comment.