diff options
| author | Madeline <46743919+MaddyUnderStars@users.noreply.github.com> | 2023-09-13 19:43:54 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-13 19:43:54 +1000 |
| commit | d55f755d6c8018cb4608f7e4315a11ad5bafc6bf (patch) | |
| tree | 676eb817634c10c455e1ee53339731735ad56c1b /README.md | |
| parent | * allow limit=1 (diff) | |
| download | server-d55f755d6c8018cb4608f7e4315a11ad5bafc6bf.tar.xz | |
Add simple about and clients to readme #1098
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md index c990c1d1..9e1d9490 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ ## [About](https://spacebar.chat) +Spacebar/server is a Discord backend re-implementation and extension. +We aim to reverse engineer and add additional features to the Discord backend, while remaining completely backwards compatible with existing bots, applications, and clients. + This repository contains: - [Spacebar HTTP API Server](/src/api) @@ -23,6 +26,13 @@ This repository contains: - [HTTP CDN Server](/src/cdn) - [Utility and Database Models](/src/util) +## [Documentation](https://docs.spacebar.chat) + ## [Contributing](https://docs.spacebar.chat/contributing/) -## [Setup](https://docs.spacebar.chat/setup/server/) +## Clients + +You *should* be able to use any client designed for Discord.com to connect to a Spacebar instance. +However, some incompatibilities still exist between Spacebar and Discord. For this reason, not every client will connect. +The [WIP official Spacebar client](https://github.com/spacebarchat/client) will always work. +You can find a [live version here](https://app.spacebar.chat). |