chore(release): 0.2.1

Signed-off-by: kjuulh <contact@kjuulh.io>

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2024-08-07
+
+### Docs
+- add a small readme
+
 ## [0.2.0] - 2024-08-07
 
 ### Added

Cargo.toml

@@ -3,7 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.2.0"
+version = "0.2.1"
 
 [workspace.dependencies]
 mad = { path = "crates/mad" }

README.md

@@ -0,0 +1,43 @@
+# MAD 
+
+Mad is a life-cycle manager for long running rust operations.
+
+- Webservers
+- Queue bindings
+- gRPC servers etc
+- Cron runners
+
+It is supposed to be the main thing the application runs, and everything from it is spawned and managed by it.
+
+```rust
+struct WaitServer {}
+
+#[async_trait]
+impl Component for WaitServer {
+    fn name(&self) -> Option<String> {
+        Some("NeverEndingRun".into())
+    }
+
+    async fn run(&self, cancellation: CancellationToken) -> Result<(), mad::MadError> {
+        let millis_wait = rand::thread_rng().gen_range(50..1000);
+
+        // Simulates a server running for some time. Is normally supposed to be futures blocking indefinitely
+        tokio::time::sleep(std::time::Duration::from_millis(millis_wait)).await;
+
+        Ok(())
+    }
+}
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    Mad::builder()
+        .add(WaitServer {})
+        .add(WaitServer {})
+        .add(WaitServer {})
+        .run()
+        .await?;
+
+    Ok(())
+}
+```
+