From 34057597ffd09813ba369ec9dc4185698f56094f Mon Sep 17 00:00:00 2001
From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com>
Date: Tue, 25 May 2021 01:20:14 +0200
Subject: [PATCH] :pencil: Update readme

---
 README.md    | 32 ++++++++++++++++++++++++++------
 package.json |  2 +-
 2 files changed, 27 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index c2d275c4..42e1489c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,29 @@
-# server-util
+<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>
 
-add to package.json:
+<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>
 
-```json
-"start": "npm run build:util && npm run build && node dist/",
-"build": "tsc -b .",
-"build:util": "tsc -b ./node_modules/fosscord-server-util/"
+## [About](https://docs.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 [voice-gateaway](https://github.com/fosscord/fosscord-api).
+
+It contains all mongoose database models and utility functions.
+
+## Installation
+
+```bash
+npm install @fosscord/server-util
 ```
diff --git a/package.json b/package.json
index 2095533d..3fcb14dc 100644
--- a/package.json
+++ b/package.json
@@ -24,7 +24,7 @@
 	"bugs": {
 		"url": "https://github.com/fosscord/fosscord-server-util/issues"
 	},
-	"homepage": "https://github.com/fosscord/fosscord-server-util#readme",
+	"homepage": "https://docs.fosscord.com/",
 	"dependencies": {
 		"@types/jsonwebtoken": "^8.5.0",
 		"@types/mongoose-autopopulate": "^0.10.1",