From e05a9d3d11fa507b4f57774dc3fb8d261c0d0c13 Mon Sep 17 00:00:00 2001
From: 409 <409dev@protonmail.com>
Date: Tue, 17 Jun 2025 23:28:19 +0200
Subject: [PATCH] update `README.md`

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

diff --git a/README.md b/README.md
index 6c257e1..5116450 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,30 @@
 # ArcHIVE
 
 A lightweight in-memory database written in Rust
+
+## Usage
+
+### CLI
+
+Download a binary or compile it yourself using `cargo build --release --bin archive-cli`
+To compile the CLI and install it globally run `cargo install --path .`
+
+### Server
+
+#### Docker
+
+The repository contains a simple `compose.yaml`
+
+#### Binary
+
+Alternatively you can run the server binary directly
+Download a binary or compile it yourself using `cargo build --release --bin archive-server`
+
+#### Environment variables
+
+This is a list of the server's environment variables and their default values:
+
+- SERVER_HOST=0.0.0.0
+- SERVER_PORT=6171
+- MAX_CONNECTIONS=256
+- LOG_LEVEL=info