Skip to content

docs(backend): add product intro and control-plane scope to README #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Maxima24 merged 1 commit into from
Sep 22, 2026
Merged

docs(backend): add product intro and control-plane scope to README #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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).
Loading