From da1511cb9ffffebd9304415ff7945e157109aba7 Mon Sep 17 00:00:00 2001 From: Madeline <46743919+MaddyUnderStars@users.noreply.github.com> Date: Wed, 3 Jan 2024 11:44:24 +1100 Subject: [PATCH] copy readme from .github repo --- README.md | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bded556..c83ad48 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@

+ +

Spacebar

+

- + @@ -17,8 +20,9 @@ Spacebar is a free, opensource selfhostable discord-compatible chat, voice and video platform. -* **Selfhostable** ([Setup Docs](https://docs.spacebar.chat/setup/server)) -* **Open Source** ([GitHub Organization](https://github.com/spacebarchat)) +* **Discord-compatible** (Use all your custom clients/bots with minimal changes) +* **Selfhostable** ([Server](https://github.com/spacebarchat/server)) +* **Open Source** ([GitHub Organization]()) * **Configurable** (Configure every aspect and limits to your needs) * **Decentralized** (no abuse of power and doesn't have a single point of failure) * **Extendable** (secure and cross-platform plugin system) @@ -28,31 +32,25 @@ Spacebar is a free, opensource selfhostable discord-compatible chat, voice and v Logo by [@ItsRealmy](https://github.com/ItsRealmy). Original logo by [@nwlandas](https://twitter.com/nwlandas). -### Installation - -* [Client](https://github.com/spacebarchat/client) -* [Server](https://github.com/spacebarchat/server) (very early pre release) - -### Support - -[Our current discord.com Server](https://discord.gg/ZrnGQP6p3d) - -If we are finished we'll host our own support server. +### Usage and Support +You can find setup guides and lots of other information in our [Documentation](https://docs.spacebar.chat) +For any kind of support regarding Spacebar, feel free to ask questions in our [Discord guild](https://discord.gg/ZrnGQP6p3d). ### Repositories -| Repo name | Brief description +| Repo name | Brief description | | :--- | :--- | -| [Server](https://github.com/spacebarchat/server) | Spacebar API + Gateway + CDN Server + WebRTC + Admin Dashboard -| [Client](https://github.com/spacebarchat/client) | Spacebar Client compatible with spacebar-server and discord.com -| [Docs](https://github.com/spacebarchat/docs) | Documentation of Spacebar +| [Server](https://github.com/spacebarchat/server) | Spacebar API + Gateway + CDN Server + WebRTC + Admin Dashboard | +| [Client](https://github.com/spacebarchat/client) | Spacebar Client compatible with Spacebar-server and discord.com | +| [Docs](https://github.com/spacebarchat/docs) | Documentation of Spacebar | +| [Landing page](https://github.com/spacebarchat/landingpage) | Our [Homepage](https://spacebar.chat) | ### Contribute -This project is only possible by volunteers like you and me, your contribution is very much appreciated. - -If you would like to contribute then [read this guide](https://docs.spacebar.chat/contributing/). +This project is only possible by volunteers like you your contribution is very much appreciated. +You can find information about how to contribute [here](https://docs.spacebar.chat/contributing/). +We also mark issues as "Good first issues" if you're looking for things to get you started. ### License