diff --git a/README.md b/README.md index a9b42cb..35ed782 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,36 @@ -# Trinity +
+ + + + + + TRINITY + + +### A personal AI agent that runs on your own machine + +It remembers you, learns procedures, acts through tools under a permission gate,
+reaches you on whatever surface you are using, and does not lose your work when something crashes. + +
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14772/badge)](https://www.bestpractices.dev/projects/14772) +[![Gate](https://img.shields.io/github/actions/workflow/status/ScriptKittyOS/Trinity/gate.yml?branch=main&style=flat-square&label=gate&labelColor=1b2420&color=2ea043)](https://github.com/ScriptKittyOS/Trinity/actions/workflows/gate.yml) +[![License](https://img.shields.io/badge/license-Apache--2.0-2ea043?style=flat-square&labelColor=1b2420)](LICENSE) +[![Elixir](https://img.shields.io/badge/Elixir%20%2F%20OTP-on%20the%20BEAM-2ea043?style=flat-square&labelColor=1b2420)](#why-the-beam) + +
+ +**[Quick start](#running-from-source)**  ·  +**[Architecture](docs/01-architecture.md)**  ·  +**[Security model](docs/07-security-model.md)**  ·  +**[Assurance case](docs/10-assurance-case.md)**  ·  +**[Roadmap](ROADMAP.md)** + +
-A personal AI agent that runs on your own machine. It remembers you, learns procedures, acts -through tools under a permission gate, reaches you on whatever surface you are using, and does -not lose your work when something crashes. +--- Trinity is built on Elixir and the BEAM, with Phoenix LiveView for the interface, and ships as a desktop application. Apache-2.0, developed in the open from the first commit. @@ -14,8 +39,9 @@ desktop application. Apache-2.0, developed in the open from the first commit. Pre-alpha, and usable from source. Milestones M0 to M4 are approved, **M5a Automates** with them (050, the scheduler; 059, the MCP measurement; 060, the MCP client; 061, the MCP server; 062, MCP -authorization), and the first slice of M5b (070, the gateway core): 25 slices, each merged with a -merge commit and tagged `slice/NNN` (`git tag -l 'slice/*' | wc -l` → 25, on 2026-09-23). What +authorization), and the first slice of M5b (070, the gateway core), with 002 (the supply chain +slice) beside them: 26 slices, each merged with a merge commit and tagged `slice/NNN` +(`git tag -l 'slice/*' | wc -l` → 26, on 2026-09-23). What that means in practice: **Assessed against a recognised baseline.** Trinity holds the diff --git a/docs/assets/trinity-icon-128.png b/docs/assets/trinity-icon-128.png new file mode 100644 index 0000000..b1667bf Binary files /dev/null and b/docs/assets/trinity-icon-128.png differ diff --git a/docs/assets/trinity-icon.png b/docs/assets/trinity-icon.png new file mode 100644 index 0000000..a16e7e0 Binary files /dev/null and b/docs/assets/trinity-icon.png differ diff --git a/docs/assets/wordmark-sm.svg b/docs/assets/wordmark-sm.svg new file mode 100644 index 0000000..f3d66b3 --- /dev/null +++ b/docs/assets/wordmark-sm.svg @@ -0,0 +1,67 @@ + + + + TRINITY + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/wordmark.svg b/docs/assets/wordmark.svg new file mode 100644 index 0000000..eb0002c --- /dev/null +++ b/docs/assets/wordmark.svg @@ -0,0 +1,67 @@ + + + + TRINITY + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +