From 1d6a23f6307ea1a1225ca8b2f2b91f78d1323416 Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Wed, 1 May 2024 16:23:53 +0200
Subject: Add usage instructions to README.md

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index b415daa..c4a12d7 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,23 @@
 # Ceres - Recipe server for local networks
 
+## Usage
+
+The `ceres` executable can be called without any arguments to start the server
+with the default configuration `default_config.json`:
+
+```
+./ceres
+```
+
+A custom configuration can be passed with the `-c` flag:
+
+```
+./ceres -c path/to/custom_config.json
+```
+
+Further command line options are described in the help page which can be
+retrieved by calling `./ceres -h`.
+
 ## Build instructions
 
 The following build dependencies are required:
-- 
cgit v1.2.3-70-g09d2