diff --git a/README.md b/README.md index c679e685..1c9e6cec 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,35 @@ -# Fosscord Server -Consists of: - * HTTP Rest API - * CDN - * Gateway - * RTC +

+ +

+

Fosscord Server

-## Dev getting started -1. Install deps: `npm i` -2. TODO: Configure -3. Start the server: - * To run all at once, run `npm start` in root directory. - * To run api, do `npm start` in `api` folder - * To run cdn, do `npm start` in `cdn` folder - * To run gateway, do `npm start` in `gateway` folder +

+ + + + + + + + +

+ +## [About](https://fosscord.com) + +This repository contains: + +- [Fosscord HTTP API Server](https://github.com/fosscord/fosscord-server/tree/master/api) +- [WebSocket Gateway Server](https://github.com/fosscord/fosscord-server/tree/master/gateway) +- [HTTP CDN Server](https://github.com/fosscord/fosscord-server/tree/master/cdn) +- [Utility and Database Models](https://github.com/fosscord/fosscord-server/tree/master/util) +- [RTC Server](https://github.com/fosscord/fosscord-server/tree/master/rtc) +- [WebRTC Server](https://github.com/fosscord/fosscord-server/tree/master/webrtc) +- [Admin Dashboard](https://github.com/fosscord/fosscord-server/tree/master/dashboard) + +## [Ressources](https://docs.fosscord.com/resources/) + +- [Contributing](https://docs.fosscord.com/contributing/) + +## [Download](https://github.com/fosscord/fosscord-server/releases) + +- _is not done yet_