diff --git a/README.md b/README.md index 801a1f7..daab7bf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ # TorroMail +[![CI](https://img.shields.io/github/actions/workflow/status/mahype/TorroMail/ci.yml?branch=main&label=CI&logo=githubactions&logoColor=white)](https://github.com/mahype/TorroMail/actions/workflows/ci.yml) +[![Release](https://img.shields.io/github/v/release/mahype/TorroMail?sort=semver&color=D50C0C)](https://github.com/mahype/TorroMail/releases/latest) +[![Downloads](https://img.shields.io/github/downloads/mahype/TorroMail/total?color=D50C0C)](https://github.com/mahype/TorroMail/releases) +[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)](#license) +[![Platforms](https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)](https://github.com/mahype/TorroMail/releases/latest) +[![MCP](https://img.shields.io/badge/MCP-server-8A2BE2)](https://modelcontextprotocol.io) +[![Rust](https://img.shields.io/badge/Rust-stable-000000?logo=rust)](Cargo.toml) +[![Swift 6](https://img.shields.io/badge/Swift-6-F05138?logo=swift&logoColor=white)](apps/TorroMailApp) + +**Your mailboxes for AI assistants — nothing leaves without your say-so.** + +

+ The TorroMail app on macOS: server status, connected assistants, mail accounts and recent assistant activity +

+ TorroMail is a local mail access layer for agents. It retrieves mail from configured accounts and exposes mail capabilities through an MCP server. The project is open-source and open-interface-first: the MCP contract and local safety model are @@ -15,6 +30,32 @@ changes out of MCP tools. MCP clients can search, read within policy, prepare risky actions, and inspect read-only admin state. The native app owns configuration and user confirmation. +## Screenshots + +Both surfaces do the same job — accounts, permissions, connected assistants, the +log — and neither shows your mail. The data below is a demo setup. + +### macOS app + +| Permissions per account | Connected assistants | +| --- | --- | +| ![Account permissions: presets from read-only to full access, each right as its own switch](docs/screenshots/app-permissions.png) | ![MCP Clients: which assistants are installed and connected](docs/screenshots/app-clients.png) | + +
+Client detail + +![Claude Desktop detail: shared accounts, connection and the checks behind it](docs/screenshots/app-client-detail.png) + +
+ +### Terminal (`torromail`) — macOS, Linux, Windows + +![torromail overview: status, accounts and recent assistant activity](docs/screenshots/cli-overview.png) + +| Permissions per account | Connected assistants | +| --- | --- | +| ![torromail account permissions](docs/screenshots/cli-permissions.png) | ![torromail MCP clients](docs/screenshots/cli-clients.png) | + ## Product Boundaries - Build the mail retrieval, policy, cache, and MCP interface first. @@ -83,3 +124,8 @@ first, so nothing half-finished is ever the latest release. Installed Mac copies can check that feed automatically or on demand. See [docs/RELEASING.md](docs/RELEASING.md) for versioning rules, the required signing secrets, and how to build a release locally. + +## License + +Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or +[MIT license](LICENSE-MIT) at your option. diff --git a/docs/screenshots/app-client-detail.png b/docs/screenshots/app-client-detail.png new file mode 100644 index 0000000..6ee390e Binary files /dev/null and b/docs/screenshots/app-client-detail.png differ diff --git a/docs/screenshots/app-clients.png b/docs/screenshots/app-clients.png new file mode 100644 index 0000000..7ddb2fb Binary files /dev/null and b/docs/screenshots/app-clients.png differ diff --git a/docs/screenshots/app-overview.png b/docs/screenshots/app-overview.png new file mode 100644 index 0000000..82dfde0 Binary files /dev/null and b/docs/screenshots/app-overview.png differ diff --git a/docs/screenshots/app-permissions.png b/docs/screenshots/app-permissions.png new file mode 100644 index 0000000..155ac45 Binary files /dev/null and b/docs/screenshots/app-permissions.png differ diff --git a/docs/screenshots/cli-clients.png b/docs/screenshots/cli-clients.png new file mode 100644 index 0000000..3b74f42 Binary files /dev/null and b/docs/screenshots/cli-clients.png differ diff --git a/docs/screenshots/cli-overview.png b/docs/screenshots/cli-overview.png new file mode 100644 index 0000000..cc0ce5b Binary files /dev/null and b/docs/screenshots/cli-overview.png differ diff --git a/docs/screenshots/cli-permissions.png b/docs/screenshots/cli-permissions.png new file mode 100644 index 0000000..462eb90 Binary files /dev/null and b/docs/screenshots/cli-permissions.png differ