docs: update before beta

README.md

@@ -1,4 +1,55 @@
-# Chall-Manager
+<div align="center">
+    <h1>Chall-Manager</h1>
+    <p><b>Challenge Scenarios on Demand, anywhere, anytime, of any size, and for anyone </b><p>
+    <a href="https://pkg.go.dev/github.com/ctfer-io/chall-manager"><img src="https://shields.io/badge/-reference-blue?logo=go&style=for-the-badge" alt="reference"></a>
+    <a href="https://hub.docker.com/r/ctferio/chall-manager"><img src="https://img.shields.io/docker/pulls/ctferio/victor?style=for-the-badge" alt="chall-manager docker pulls"></a>
+	<a href="https://goreportcard.com/report/github.com/ctfer-io/chall-manager"><img src="https://goreportcard.com/badge/github.com/ctfer-io/chall-manager?style=for-the-badge" alt="go report"></a>
+	<a href="https://coveralls.io/github/ctfer-io/chall-manager?branch=main"><img src="https://img.shields.io/coverallsCoverage/github/ctfer-io/chall-manager?style=for-the-badge" alt="Coverage Status"></a>
+	<br>
+	<a href=""><img src="https://img.shields.io/github/license/ctfer-io/chall-manager?style=for-the-badge" alt="License"></a>
+	<a href="https://github.com/ctfer-io/chall-manager/actions?query=workflow%3Aci+"><img src="https://img.shields.io/github/actions/workflow/status/ctfer-io/chall-manager/ci.yaml?style=for-the-badge&label=CI" alt="CI"></a>
+	<a href="https://github.com/ctfer-io/chall-manager/actions/workflows/codeql-analysis.yaml"><img src="https://img.shields.io/github/actions/workflow/status/ctfer-io/chall-manager/codeql-analysis.yaml?style=for-the-badge&label=CodeQL" alt="CodeQL"></a>
+    <br>
+    <a href="https://securityscorecards.dev/viewer/?uri=github.com/ctfer-io/chall-manager"><img src="https://img.shields.io/ossf-scorecard/github.com/ctfer-io/chall-manager?label=openssf%20scorecard&style=for-the-badge" alt="OpenSSF Scoreboard"></a>
+</div>
+
+> [!CAUTION]
+> Chall-Manager is currently in public beta phase.
+> It could be run in production, but breaking changes are subject to happen in the upcoming months until General Availability.
+> 
+> It has been tested under production workload during the NoBrackets 2024.
+
+- [What ?](#what-)
+- [Why ?](#why-)
+- [Trophy list](#trophy-list)
+- [Development setup](#development-setup)
+
+## What ?
+
+Chall-Manager is a **platform-agnostic** system able to **start Challenges on Demand** of a player: an **Instance**.
+It **abstracts the deployment** thus is **able to cover all existing and future** systems with an API and CRUD operations on a resource: Kubernetes Pods, Proxmox VMs, AWS IAM, FPGA, ... at the only cost of a [Pulumi provider](https://www.pulumi.com/registry/).
+To **avoid resources overconsumption**, it janitors them once expired.
+
+To ease deployments, we created _"recipes"_ in a [SDK](sdk/).
+
+Please [**Read the documentation**](https://ctfer.io/docs/chall-manager/) for better understanding.
+
+<div align="center">
+    <img src="webdocs/design/architecture/software.excalidraw.png" width="1000px">
+</div>
+
+## Why ?
+
+Alternatives exist, but were not sufficient: they focused on **a single technology** (e.g. Docker or Kubernetes only) and for **one specific platform**.
+
+With Chall-Manager, you are now able to abstract this all thus don't require to follow other's technical choices.
+
+## Trophy list
+
+The following list contains all known events were Chall-Manager has been operated in production:
+Please [open an issue](https://github.com/ctfer-io/chall-manager/issues/new) to add your event to the list if we did not ourself.
+
+- 2024/11/20 [NoBracketsCTF 2024](https://github.com/nobrackets-ctf/NoBrackets-2024)
 
 ## Development setup
 

SECURITY.md

@@ -1,6 +1,6 @@
 # Reporting Security Issues
 
-Please report any security issues you discovered in the chall-manager to ctfer-io@protonmail.com.
+Please report any security issues you discovered in `chall-manager`, `chall-manager-janitor` or the security-by-default recipes of the [SDK](sdk/) to ctfer-io@protonmail.com.
 
 We will assess the risk, plus make a fix available before we create a GitHub issue.
 
@@ -10,4 +10,8 @@ Thank you for your contribution.
 
 ## Refering to this repository
 
-To refer to this repository using a CPE v2.3, please use `cpe:2.3:a:ctfer-io:chall-manager:*:*:*:*:*:*:*:*` with the `version` set to the tag you are using.
+To refer to this repository using a CPE v2.3, please use respectively:
+- `chall-manager`: `cpe:2.3:a:ctfer-io:chall-manager:*:*:*:*:*:*:*:*`
+- `chall-manager-janitor`: `cpe:2.3:a:ctfer-io:chall-manager-janitor:*:*:*:*:*:*:*:*`
+
+Use with the `version` set to the tag you are using.