chore: edited config.yaml for universal use cases, +readme.md

README.md

@@ -0,0 +1,31 @@
+# Hydrogen
+**Lightweight, extensible server security auditing — from a single YAML file.**
+
+Hydrogen runs your security checks concurrently, evaluates severity, and delivers reports wherever you need them — disk, webhook, or your own custom transport. Focused on extensibility, built for your server.
+
+### Why Hydrogen?
+- **Extensible by design** — modules, renderers, and transports are all plugins. Write a Python class, drop it in, it works.
+- **Concurrent by default** — checks run in parallel with configurable concurrency.
+- **Multiple outputs** — JSON to disk _and_ a webhook to your SIEM? One config line each.
+- **CI-native** — `strict_mode` + severity thresholds produce a clean exit code for your pipeline.
+
+### Quick start
+```sh
+git clone https://github.com/agonyecho/hydrogen && cd hydrogen
+pip install -e . # Installs hydrogen as local package
+hydrogen -c config.yaml
+```
+
+or
+
+```sh
+git clone https://github.com/agonyecho/hydrogen && cd hydrogen
+python -m venv venv && source ./venv/bin/activate && pip install -r requirements.txt
+python main.py -c config.yaml
+```
+
+### Docs
+- [Configuration](HYDROGEN_CONFIGURATION.md) — every YAML knob explained
+- [Writing modules](HYDROGEN_SECURITY_MODULES.md) — `MANIFEST`, `build_worker`, `CONFIG_MODEL`
+- [Writing transports](HYDROGEN_TRANSPORTS.md) — deliver reports anywhere
+- [Writing renderers](HYDROGEN_RENDERERS.md) — JSON, Markdown, or your own format