Skip to content

Commit c7aa22f

Browse files
authored
Merge pull request #79 from ScriptKittyOS/docs/readme-identity
Give the README Trinity's own identity Signed-off-by: Ayla Croft <aylacroft@proton.me>
2 parents e14b669 + 70cfa54 commit c7aa22f

5 files changed

Lines changed: 166 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
<!-- SPDX-License-Identifier: Apache-2.0 -->
2-
# Trinity
2+
<div align="center">
3+
4+
<img src="docs/assets/trinity-icon.png" alt="" width="132">
5+
6+
<picture>
7+
<source media="(max-width: 600px)" srcset="docs/assets/wordmark-sm.svg">
8+
<img src="docs/assets/wordmark.svg" alt="TRINITY" width="520">
9+
</picture>
10+
11+
### A personal AI agent that runs on your own machine
12+
13+
It remembers you, learns procedures, acts through tools under a permission gate,<br>
14+
reaches you on whatever surface you are using, and does not lose your work when something crashes.
15+
16+
<br>
317

418
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/14772/badge)](https://www.bestpractices.dev/projects/14772)
19+
[![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)
20+
[![License](https://img.shields.io/badge/license-Apache--2.0-2ea043?style=flat-square&labelColor=1b2420)](LICENSE)
21+
[![Elixir](https://img.shields.io/badge/Elixir%20%2F%20OTP-on%20the%20BEAM-2ea043?style=flat-square&labelColor=1b2420)](#why-the-beam)
22+
23+
<br>
24+
25+
**[Quick start](#running-from-source)** &nbsp;·&nbsp;
26+
**[Architecture](docs/01-architecture.md)** &nbsp;·&nbsp;
27+
**[Security model](docs/07-security-model.md)** &nbsp;·&nbsp;
28+
**[Assurance case](docs/10-assurance-case.md)** &nbsp;·&nbsp;
29+
**[Roadmap](ROADMAP.md)**
30+
31+
</div>
532

6-
A personal AI agent that runs on your own machine. It remembers you, learns procedures, acts
7-
through tools under a permission gate, reaches you on whatever surface you are using, and does
8-
not lose your work when something crashes.
33+
---
934

1035
Trinity is built on Elixir and the BEAM, with Phoenix LiveView for the interface, and ships as a
1136
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.
1439

1540
Pre-alpha, and usable from source. Milestones M0 to M4 are approved, **M5a Automates** with them
1641
(050, the scheduler; 059, the MCP measurement; 060, the MCP client; 061, the MCP server; 062, MCP
17-
authorization), and the first slice of M5b (070, the gateway core): 25 slices, each merged with a
18-
merge commit and tagged `slice/NNN` (`git tag -l 'slice/*' | wc -l` → 25, on 2026-09-23). What
42+
authorization), and the first slice of M5b (070, the gateway core), with 002 (the supply chain
43+
slice) beside them: 26 slices, each merged with a merge commit and tagged `slice/NNN`
44+
(`git tag -l 'slice/*' | wc -l` → 26, on 2026-09-23). What
1945
that means in practice:
2046

2147
**Assessed against a recognised baseline.** Trinity holds the

‎docs/assets/trinity-icon-128.png‎

19.1 KB
Loading

‎docs/assets/trinity-icon.png‎

178 KB
Loading

‎docs/assets/wordmark-sm.svg‎

Lines changed: 67 additions & 0 deletions
Loading

‎docs/assets/wordmark.svg‎

Lines changed: 67 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)