summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-12 20:32:55 +0200
committerFlam3rboy <34555296+Flam3rboy@users.noreply.github.com>2021-08-12 20:32:55 +0200
commitca432fda543c3d124bd507de7156400058fda802 (patch)
tree5d20deb8d4d89e26887668a59d45ad70789267eb /README.md
parentMerge branch 'master' into util (diff)
parentMerge pull request #21 from ItsNewe/master (diff)
downloadserver-ts-ca432fda543c3d124bd507de7156400058fda802.tar.xz
Merge branch 'rtc'
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 10 insertions, 21 deletions
diff --git a/README.md b/README.md

index 9c983acd..ee452adf 100644 --- a/README.md +++ b/README.md
@@ -1,29 +1,18 @@ -<p align="center"> - <img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets/logo_big_transparent.png" /> -</p> -<h1 align="center">Fosscord server util</h1> +# Fosscord-media -<p> - <a href="https://discord.gg/ZrnGQP6p3d"> - <img src="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff" /> - </a> - <img src="https://img.shields.io/static/v1?label=Status&message=Development&color=blue"> - <a title="Crowdin" target="_blank" href="https://translate.fosscord.com/"><img src="https://badges.crowdin.net/fosscord/localized.svg"></a> - <a href="https://opencollective.com/fosscord"> - <img src="https://opencollective.com/fosscord/tiers/badge.svg"> - </a> -</p> +A Fosscord media (voice and video) server -## [About](https://fosscord.com) - -Fosscord is a free open source selfhostable chat, voice and video discord-compatible platform. +## Installation -Fosscord server util contains all necessary logic that is shared between the [api](https://github.com/fosscord/fosscord-api), [gateway](https://github.com/fosscord/fosscord-gateway) and [cdn](https://github.com/fosscord/fosscord-cdn). +### Prerequisites -It contains all mongoose database models and utility functions. +- Install the [libdatachannel](https://github.com/paullouisageneau/libdatachannel) library +- Install the [libmongocxx](http://mongocxx.org/mongocxx-v3/installation/) driver and its requirements -## Installation +### Building ```bash -npm install @fosscord/server-util +$ cmake +$ cd build +$ make ```