From c6fe5f117d65aa1f3248f2ca51c88b57cff293ef Mon Sep 17 00:00:00 2001 From: Maxima24 Date: Tue, 22 Sep 2026 10:40:06 +0100 Subject: [PATCH] docs(backend): add product intro and control-plane scope to README Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2365a11..9af98c8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ -# backend — Control Plane +# Clipit backend — Control Plane -Identity, device registry, authorization, share sessions and revocation for the Cross-Device -Clipboard. **Not** the clipboard data plane: no endpoint here accepts, relays or stores clipboard -content. +Clipit (the Cross-Device Clipboard) lets you copy on one machine and paste on another. It keeps +traffic local whenever the devices are local. + +> **Status: early and in active development.** Built in public. + +## Why + +Moving a snippet from a laptop to a desktop sitting next to it shouldn't mean emailing yourself or +routing it through someone else's server. Two devices on the same desk shouldn't need a round trip +to a server to share a clipboard. + +## Where this service fits + +This repo is the **control plane**. It handles identity, the device registry, pairing, +authorization, share sessions and revocation. It decides *which* devices may talk to each other +and gives them signed peer rosters so they can check that for themselves. + +It is **not** the clipboard data plane. No endpoint here accepts, relays or stores clipboard +content. Content moves between devices, never through this backend (ADR-001). Docs, ADRs and contracts live on `main`. See `DEV_GUIDE.md` there for the branch layout, and §3.2 for checking `main` out as a sibling worktree. @@ -60,3 +76,7 @@ npm run test:unit && npm run test:contract npm run test:integration && npm run test:security && npm run test:e2e npm run build ``` + +## Author + +Built by [Faith Popoola](https://github.com/Maxima24).