From ee6751eb3d9bb675c721a49c9af8c6b3ed91db42 Mon Sep 17 00:00:00 2001 From: Devmani Tripathi <265634822+devXyi@users.noreply.github.com> Date: Fri, 16 Oct 2026 01:55:50 -0700 Subject: [PATCH] docs: animate and make README interactive --- README.md | 121 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 95 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index ff8ff67..d943156 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,103 @@
-
+ + Prexus Intelligence animated banner + -``` -██████╗ ██████╗ ███████╗██╗ ██╗██╗ ██╗███████╗ -██╔══██╗██╔══██╗██╔════╝╚██╗██╔╝██║ ██║██╔════╝ -██████╔╝██████╔╝█████╗ ╚███╔╝ ██║ ██║███████╗ -██╔═══╝ ██╔══██╗██╔══╝ ██╔██╗ ██║ ██║╚════██║ -██║ ██║ ██║███████╗██╔╝ ██╗╚██████╔╝███████║ -╚═╝ ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝ -``` + + Animated tagline: anticipate risk, explore scenarios, structure decisions + -### **Sovereign AI Intelligence System** +
-*Anticipating systemic risk before it materialises* +[![Status](https://img.shields.io/badge/Stage-Early--stage%20prototype-0EA5E9?style=for-the-badge)](https://github.com/devXyi/prexus-intelligence) +[![Engine](https://img.shields.io/badge/Compute-Python%20%2B%20Rust-EF4444?style=for-the-badge)](https://github.com/devXyi/prexus-intelligence) +[![Security](https://img.shields.io/badge/Security-Auth%20%7C%20RBAC%20%7C%20Audit-8B5CF6?style=for-the-badge)](https://github.com/devXyi/prexus-intelligence) +[![License](https://img.shields.io/badge/License-See%20NOTICE-10B981?style=for-the-badge)](./NOTICE)
-[![Status](https://img.shields.io/badge/Status-Early_Stage_Prototype-0EA5E9?style=flat-square&logoColor=white)](.) -[![Engine](https://img.shields.io/badge/Engine-Monte_Carlo_%2B_Rust-EF4444?style=flat-square)](.) -[![Clearance](https://img.shields.io/badge/Classification-Institutional_Use-F59E0B?style=flat-square)](.) -[![License UI](https://img.shields.io/badge/UI%2FDesign-Apache_2.0-10B981?style=flat-square)](./LICENSE) -[![License Core](https://img.shields.io/badge/Backend%2FEngine-Proprietary-8B5CF6?style=flat-square)](./NOTICE) +**A risk-intelligence platform exploring how complex systems can be modelled before decisions are made.** + +[Explore the platform](#-explore-prexus) · [Architecture](#-system-map) · [Modules](#-intelligence-modules) · [API](#-api-reference) · [Security](#-security-model) · [Roadmap](#-roadmap)
-*For governments, financial institutions, and enterprise operators* +Scroll to explore + +
--- -[Platform Overview](#what-is-prexus) · [Architecture](#architecture) · [Intelligence Modules](#intelligence-modules) · [API Reference](#api-reference) · [Licensing](#licensing) +## ✦ Explore Prexus - +Pick a starting point — each panel expands right here in the README. -
+
+🌐 Platform overview + +Prexus is an early-stage, multi-module intelligence platform focused on risk modelling, scenario analysis, and probabilistic decision support across climate, infrastructure, and other complex domains. + +**Design principle:** make uncertainty explicit; do not present forecasts as certainty. + +
+ +
+🧮 How the simulation flow works + +```mermaid +flowchart TD + A["Define assets & assumptions"] --> B["Ingest available signals"] + B --> C["Build scenario distributions"] + C --> D["Run simulation engine"] + D --> E["Summarise risk metrics"] + E --> F["Review evidence & limitations"] + F --> G["Decision support"] + style A fill:#102A43,stroke:#55D6FF,color:#EAFBFF + style D fill:#102A43,stroke:#55D6FF,color:#EAFBFF + style G fill:#102A43,stroke:#55D6FF,color:#EAFBFF +``` + +The diagram is a conceptual flow, not a claim that every source or model is enabled in every deployment. + +
+ +
+🧭 Jump into a module + +| Module | Focus | Current framing | +|---|---|---| +| [Meteorium](#-meteorium--climate-risk-intelligence) | Physical climate exposure and risk metrics | First climate-risk module | +| [Raksha](#-raksha--threat-intelligence-module) | Threat-signal correlation and situational awareness | In development | +| [Healtho](#-healtho--health-intelligence-module) | Population-health and system-load scenarios | Planned / in build | + +
+ +
+🔌 API quick peek + +| Need | Endpoint | +|---|---| +| Check service liveness | `GET /health` | +| Check readiness | `GET /ready` | +| Create an account | `POST /register` | +| Sign in | `POST /login` | +| Submit an access application | `POST /apply` | +| Read applications (admin permission required) | `GET /admin/applications` | + +See the [full API reference](#-api-reference). Actual availability depends on the deployed gateway configuration. + +
+ +
+🛡️ Security & maturity notes + +- Authentication and role-based permissions are implemented in the API gateway. +- The repository includes automated security and dependency checks. +- Some capabilities remain planned or in development; see the [capabilities matrix](#-platform-capabilities-matrix). +- This README is not a security certification, production-readiness claim, or guarantee of forecast accuracy. + +
--- @@ -154,10 +218,13 @@ To build a **sovereign intelligence layer** that enables:
-## Platform Architecture +## 🧩 System Map
+
+🧱 Expand the architecture overview + Prexus is built as a **distributed, polyglot system** — each layer uses the best-fit language for its role. ``` @@ -195,13 +262,15 @@ Prexus is built as a **distributed, polyglot system** — each layer uses the be | Data Adapters | Python | External data ingestion | Climate, environmental, financial signal normalisation | | Audit Ledger | Go | Immutable event log | SHA-256 hash-chained tamper-evident records | +
+
---
-## Intelligence Modules +## 🛰️ Intelligence Modules
@@ -328,7 +397,7 @@ Raksha is the geopolitical and institutional threat layer of Prexus. Named for p
-## API Reference +## 🔌 API Reference All routes are served by the Go gateway; the Python engine is a private service reachable only from the gateway. Authentication: `Authorization: Bearer ` (24 h). Rate limit: 5 req/s per IP (burst 10); `/apply`: 3 per 2 min. @@ -351,7 +420,7 @@ Errors: `400` validation · `401` missing/invalid token · `403` permission · ` `429` rate/quota · `502/503` upstream unavailable (details are logged, never returned). -## Security Model +## 🛡️ Security Model | Layer | Implemented | |---|---| @@ -450,7 +519,7 @@ curl localhost:8080/health
-## Roadmap +## 🚀 Roadmap
@@ -480,7 +549,7 @@ curl localhost:8080/health
-## Platform Capabilities Matrix +## 📊 Platform Capabilities Matrix