orbit/orbit-client-docs
orbit/orbit-client-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix the no-signup contradiction; 25 caps; honest guest/account wording

Browse source
This commit is contained in:
reverse 2026-06-20 15:46:04 +00:00
parent 78990d66b5
commit bcd2b8b1ff
No known key found for this signature in database
2 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/overview.md
View file

@ -4,15 +4,17 @@ Order: 10
# Overview
**Orbit** is a modern web client for **IRC** — the open chat protocol that has quietly run
communities for decades. It runs entirely in the browser: pick a nick and you're talking, with
**no install and no signup**.
communities for decades. It runs entirely in the browser — nothing to install — and handles
everything from a quick guest nick to a full account (SASL login and in-app registration).
Whether a deployment lets people in as guests or asks them to register is its own choice, not
the client's.
It powers [tchatou.fr](https://tchatou.fr/app/), and is built to be **re-pointed at any IRCv3
network** and **rebranded** from a single `config.json` — without recompiling.
## What makes it different
- **Full IRCv3.** Orbit negotiates 24 capabilities — SASL, message-tags, reactions, typing
- **Full IRCv3.** Orbit negotiates 25 capabilities — SASL, message-tags, reactions, typing
indicators, read-markers, multi-line messages, server-side history, account registration, and
Web Push. See [IRCv3 capabilities](https://orbit.tchatou.fr/docs/ircv3/).
- **Pluggable at runtime.** A static `config.json` is fetched on startup and sets the server,