diff options
| author | Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> | 2021-08-12 20:33:02 +0200 |
|---|---|---|
| committer | Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> | 2021-08-12 20:33:02 +0200 |
| commit | 4f2596789875b894e5b45d7cfafcc7cf6ca46aef (patch) | |
| tree | 20b4728a0ff390bd982f2346807f3176efc8c1f9 /util/README.md | |
| parent | Merge branch 'rtc' (diff) | |
| download | server-4f2596789875b894e5b45d7cfafcc7cf6ca46aef.tar.xz | |
:sparkles: util
Diffstat (limited to 'util/README.md')
| -rw-r--r-- | util/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/util/README.md b/util/README.md new file mode 100644 index 00000000..9c983acd --- /dev/null +++ b/util/README.md @@ -0,0 +1,29 @@ +<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> + +<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> + +## [About](https://fosscord.com) + +Fosscord is a free open source selfhostable chat, voice and video discord-compatible platform. + +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). + +It contains all mongoose database models and utility functions. + +## Installation + +```bash +npm install @fosscord/server-util +``` |