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

overview: reword, drop em-dashes

Browse source
This commit is contained in:
reverse 2026-06-20 19:28:28 +00:00
parent c728d32977
commit 641d58e84c
No known key found for this signature in database
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/overview.md
View file

@ -3,18 +3,18 @@ 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 — nothing to install — and handles
**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, with 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.
network** and **rebranded** from a single `config.json`, without recompiling.
## What makes it different
- **Full IRCv3.** Orbit negotiates 25 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,
@ -24,11 +24,11 @@ network** and **rebranded** from a single `config.json` — without recompiling.
closed.
- **Self-hostable.** A static build behind any web server. The project even runs its own git
server with [push-to-deploy](https://orbit.tchatou.fr/docs/push-to-deploy/).
- **Free software.** AGPL-3.0 — use it, modify it, self-host it.
- **Free software.** AGPL-3.0: use it, modify it, self-host it.
## Tech
React 19 · TypeScript · Vite · zustand. Tested with Vitest, linted, and built in CI. The codebase
is a clean modular tree — see [Architecture](https://orbit.tchatou.fr/docs/architecture/).
React 19, TypeScript, Vite and zustand. Tested with Vitest, linted, and built in CI. The codebase
is a clean modular tree; see [Architecture](https://orbit.tchatou.fr/docs/architecture/).
> New here? Jump to the [Quick start](https://orbit.tchatou.fr/docs/quick-start/) to run your own in a minute.
> New here? Jump to the [Quick start](https://orbit.tchatou.fr/docs/quick-start/) to run your own.