Skip to content

Commit eaa8688

Browse files
committed
docs: add hero logo, banner, and demo.gif to README
- Add centered logo (brand/logo.svg) at the top of the README - Add the social banner (assets/social/ethos-aegis-mythos-banner.svg) as a hero - Embed demo.gif under a new Demo section
2 parents 93a6a62 + c6c633f commit eaa8688

File tree

2 files changed

+153
-1
lines changed

2 files changed

+153
-1
lines changed

README.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# Ethos Aegis Branding
2+
<p align="center">
3+
<img src="./brand/logo.svg" alt="Ethos Aegis logo" width="420">
4+
</p>
5+
6+
<p align="center">
7+
<img src="./assets/social/ethos-aegis-mythos-banner.svg" alt="Ethos Aegis — Claude Mythos · Veriflow Immune System" width="100%">
8+
</p>
9+
10+
# Ethos Aegis — Agentic Immune Veriflow
211

312
## Logo References
413

@@ -20,5 +29,147 @@
2029
## Styled Badges
2130

2231
![Verified Badge](brand/verified_badge.svg)
32+
---
33+
34+
## 🎬 Demo
35+
36+
<p align="center">
37+
<img src="./demo.gif" alt="Ethos Aegis in action" width="100%">
38+
</p>
39+
40+
---
41+
42+
## 🚀 Quick Start
43+
44+
### Python (Ethos Aegis / Veriflow)
45+
46+
```bash
47+
# Install dependencies
48+
pip install -r requirements.txt
49+
50+
# Run the test suite
51+
pytest tests/ -q
52+
53+
# Run linting
54+
flake8 ethos_aegis/ tests/
55+
```
56+
57+
### TypeScript (Cloudflare Worker)
58+
59+
```bash
60+
# Install dependencies
61+
npm install
62+
63+
# Type-check
64+
npm run typecheck
65+
66+
# Local dev
67+
npm run worker:dev
68+
```
69+
70+
### Using Make
71+
72+
```bash
73+
make help # Show all commands
74+
make test # Run all tests
75+
make lint # Run all linters
76+
make install # Install all dependencies
77+
```
78+
79+
---
80+
81+
## 🏗️ Architecture
82+
83+
```
84+
ethos_aegis/
85+
├── mythos_runtime/ # Claude Mythos operating layer
86+
│ ├── budget.py # Token/turn budget metering
87+
│ ├── drift.py # File drift detection
88+
│ ├── memory.py # Memory ledger (MEMORY.md)
89+
│ └── swd.py # Strict Write Discipline verification
90+
└── veriflow/
91+
├── ckan_adapter.py # CKAN host fingerprinting + ingestion
92+
└── immune_system.py # VeriflowImmuneSystem orchestration
93+
94+
src/
95+
└── index.ts # Cloudflare Worker entrypoint
96+
97+
tests/
98+
├── test_mythos_runtime.py
99+
└── test_mythos_brand_contract.py
100+
```
101+
102+
---
103+
104+
## 🛡️ Core Principles
105+
106+
- **Defense-first** — never exploit-first
107+
- **Verification before conclusion** — every dataset is fingerprinted
108+
- **Provenance before confidence** — ingestion path is always logged
109+
- **Autonomic monitoring** — before manual prompting
110+
- **Schema-aware reasoning** — graceful fallback when schema unavailable
111+
112+
---
113+
114+
## 📋 Runtime Doctrine (Claude Mythos)
115+
116+
1. Probe the host
117+
2. Cache capabilities
118+
3. Select the best ingestion path
119+
4. Verify normalized rows
120+
5. Generate candidate laws and formulas
121+
6. Score by fit, semantics, coverage, stability, and complexity
122+
7. Return the answer with host profile, evidence, and ingestion provenance
123+
124+
---
125+
126+
## 🔌 Integration
127+
128+
```python
129+
from ethos_aegis.veriflow import CKANClient, VeriflowImmuneSystem
130+
131+
ckan = CKANClient("https://your-ckan-host")
132+
immune = VeriflowImmuneSystem(
133+
ckan,
134+
probe_on_startup=True,
135+
fingerprint_mode="auto",
136+
)
137+
```
138+
139+
---
140+
141+
## 📦 Project Structure
142+
143+
```
144+
.
145+
├── ethos_aegis/ # Python: core immune system
146+
├── src/ # TypeScript: Cloudflare Worker
147+
├── tests/ # Python test suite
148+
├── docs/ # Documentation
149+
├── scripts/ # Utility scripts
150+
├── plugins/ # Claude Code plugins
151+
├── schemas/ # JSON/YAML schemas
152+
└── veriflow-Sovereign-Lattice/ # Veriflow sovereign lattice module
153+
```
154+
155+
---
156+
157+
## 🤝 Contributing
158+
159+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
160+
161+
---
162+
163+
## 📄 License
164+
165+
MIT — see [LICENSE](./LICENSE).
166+
167+
---
168+
169+
## 🔗 Related
170+
171+
- [CLAUDE_MYTHOS.md](./CLAUDE_MYTHOS.md) — Operating contract for the Claude Mythos identity layer
172+
- [CHANGELOG.md](./CHANGELOG.md) — Release history
173+
- [SECURITY.md](./SECURITY.md) — Security policy
23174

24175
This document promotes a verification-first approach in branding. Ensure these assets are used consistently across all platforms to maintain brand integrity.

docker-compose.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
version: "3.9"
2-
2+
- name: Attest Build Provenance
3+
uses: actions/attest-build-provenance@v4.0.0
34
services:
45
dev:
56
image: python:3.11-slim

0 commit comments

Comments
 (0)