docs: readme and api docs for c3

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

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,