diff --git a/README.md b/README.md index 679edcc..e504cfb 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,24 @@ -

- -

-

Fosscord

- -

- - - - - - - - -

- -### [About](https://docs.fosscord.com/) - -Fosscord is **f**ree **o**pen **s**ource **s**oftware compatible to dis**cord**. It is a selfhostable Chat, Voice and Video platform similar to Slack, Rocket.chat and Discord-compatible. - -* Discord-compatible -* Selfhostable -* Open Source -* Configurable -* Secure -* Decentralized -* Extendable -* Themeable - -Logo by [@nwlandas](https://twitter.com/nwlandas). +![](./assets/readme.svg) ### Installation -_it is in development and not yet finished._ +[Server]() _(pre alpha)_ -### Support - -[https://discord.gg/ZrnGQP6p3d](https://discord.gg/ZrnGQP6p3d) - -If we are finished we'll host our own support server. - -### Feature Additions: -* End to end encryption -* Whiteboard integration +Client _not finished and still in development_ ### Repositories -| Repo name | Brief description | -| :--- | :--- | -| [UI](https://github.com/fosscord/fosscord-ui) | Open Source CSS framework in the style of Discord | -| [API](https://github.com/fosscord/fosscord-API) | Fosscord HTTP API Server for fosscord-client | -| [Gateway](https://github.com/fosscord/fosscord-gateway) | Fosscord WebSocket Gateway Server for fosscord-client | - [Docs](https://github.com/fosscord/fosscord-docs) | Documentation for Fosscord | -| [WebRTC Server](https://github.com/fosscord/fosscord-rtc) | Fosscord voice and video server | -| [Voice Gateway](https://github.com/fosscord/fosscord-voice-gateway) | Fosscord voice gateway | -| [Server-Util](https://github.com/fosscord/fosscord-server-util) | Utility functions for the all server repositories | -| [Dashboard](https://github.com/fosscord/fosscord-dashboard) | An admin dashboard for fosscord-server \(analytics, settings, administration, trust & safety\) | -| [Client](https://github.com/fosscord/fosscord-client) | Fosscord Client compatible with fosscord-server and discord.com | -| [CDN](https://github.com/fosscord/fosscord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets | -| [~~React Native CSS~~](https://github.com/fosscord/react-native-withcss) \(archived\) | ~~Library to enable css support for the client especially for themes~~ | -| [~~React Native Mediaquery~~](https://github.com/fosscord/css-mediaquery) \(archived\) | ~~Use CSS media queries with react native~~ | - -### Contribute - -This project is only possible by volunteers like you and me, your contribution is very much appreciated 🥺. - -If you want to make this project reality and and you would like to contribute then [read this issue](https://github.com/fosscord/fosscord/issues/10) first. - -### License - -Copyright (C) 2021 Fosscord and Fosscord Contributors -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as -published by the Free Software Foundation version 3 of the -License - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.de.html +| Repo name | Brief description | +| :------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | +| [UI](https://github.com/fosscord/fosscord-ui) | Open Source CSS framework in the style of Discord | +| [API](https://github.com/fosscord/fosscord-API) | Fosscord HTTP API Server for fosscord-client | +| [Gateway](https://github.com/fosscord/fosscord-gateway) | Fosscord WebSocket Gateway Server for fosscord-client | +| [Docs](https://github.com/fosscord/fosscord-docs) | Documentation for Fosscord | +| [WebRTC Server](https://github.com/fosscord/fosscord-rtc) | Fosscord voice and video server | +| [Voice Gateway](https://github.com/fosscord/fosscord-voice-gateway) | Fosscord voice gateway | +| [Server-Util](https://github.com/fosscord/fosscord-server-util) | Utility functions for the all server repositories | +| [Dashboard](https://github.com/fosscord/fosscord-dashboard) | An admin dashboard for fosscord-server \(analytics, settings, administration, trust & safety\) | +| [Client](https://github.com/fosscord/fosscord-client) | Fosscord Client compatible with fosscord-server and discord.com | +| [CDN](https://github.com/fosscord/fosscord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets | +| [~~React Native CSS~~](https://github.com/fosscord/react-native-withcss) \(archived\) | ~~Library to enable css support for the client especially for themes~~ | +| [~~React Native Mediaquery~~](https://github.com/fosscord/css-mediaquery) \(archived\) | ~~Use CSS media queries with react native~~ | diff --git a/assets/readme.svg b/assets/readme.svg new file mode 100644 index 0000000..c20d91f --- /dev/null +++ b/assets/readme.svg @@ -0,0 +1,137 @@ + + + + + + + + Fosscord + + + + + + + + + + + + + + + + + + + + + + + About + + + Fosscord is a free open source selfhostable chat, voice and video discord-compatible platform. + + • Discord-compatible + + + • Selfhostable + + + • Open Source + + + • Configurable + + + • Secure + + + • Decentralized + + + • Extendable + + + • Themeable + + + • End-to-end encryption + + + + Support + + + + + https://discord.gg/ZrnGQP6p3d + + + + + If we are finished we'll host our own support server. + + + + 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 issue + + first. + + + + + Logo by + @nwlandas + + + + License + + + + + GNU Affero General Public License V3.0 + + + + + + + + \ No newline at end of file