From 3a4125fdde32c92ae5ab40e650e1bbbd1ad882e7 Mon Sep 17 00:00:00 2001
From: PlexSheep <software@cscherr.de>
Date: Fri, 6 Sep 2024 20:03:31 +0200
Subject: [PATCH] docs: readme and api docs for c3

---
 README.md     | 28 +++++++++++++++++++++++++++-
 src/config.rs |  2 ++
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f2fe91c..87d67b6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 # Wooly-Vault
 
-Small hacking challenge for ⚒️  Rust Hackers 🦀
+A few small challenges for ⚒️  Rust Hackers 🦀
+
+## Configuration
+
+Each challenge requires some basic information to host:
+
+* secret - a string that if found signifies that the challenge was solved
+
+* addr - the network adress plus port the challenge should run on
+
+* verbosity - how verbose the logging should be
+
+* challenge - which challenge to host (there are a few)
+
+The secret cannot be inputted with a command line argument, because the arguments can often be
+seen in the process view. You may either specify a secret in the 'WOOLY_SECRET' environment
+variable or input it interactively on start.
+
+## Challenges
+
+There are a number of challenges:
+
+1. Connect by TCP
+
+2. Connect by TCP and send a special u16
+
+3. Connect by TCP, get sent dynamic math questions, solve them fast enough
diff --git a/src/config.rs b/src/config.rs
index f40c1a8..80684eb 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -32,6 +32,8 @@ pub const ENV_SECRET: &str = "WOOLY_SECRET";
 /// 1. Connect by TCP
 ///
 /// 2. Connect by TCP and send a special u16
+///
+/// 3. Connect by TCP, get sent dynamic math questions, solve them fast enough
 #[derive(Parser, Clone, PartialEq, Eq, Hash, Serialize)]
 #[command(
     author,