From: icecodder <git@icecodder.me>
Date: Mon, 2 Jan 2023 20:42:22 +0000 (+0100)
Subject: fix readme
X-Git-Tag: v0.1~25^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=50de729860ebe6280a577a5597e90dbab9ca78b2;p=matthieu%2Fnova.git

fix readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c41ca7f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Nova
+
+[![Build](https://github.com/discordnova/Nova/actions/workflows/rust.yml/badge.svg)](https://github.com/discordnova/Nova/actions/workflows/rust.yml)
+
+## What is nova ?
+
+Nova is a complete framework for building reliable and stable discord bots
+using a services based system to operate all the components needed to operate
+a discord such as the discord gateway, new discord webhooks for receiving interactions.
+Using a traditional infrastructure (sharder / process), we can quickly reach bottlenecks
+when we scale to multiple thousands of shards. Nova is a way to avoid these problems by
+building a scale-first discord framework that creates an environment that allow 
+better testing, reliability and operations easier.
+
+### Advantages
+
+With the help of Nova, you can achieve a number of things, such as
+
+* Scaling of workers independent of the number of shards
+* zero-login updates
+* Automatic shards scaling
+* Shared cache for the whole bot (without broadcastEval and other unsafe methods)
+* Stateless workers, easier to test
+* Distributed rest rate-limiting
+* Easier fine-tuned monitoring using cloud-native technologies
+* Languages agnostic apis
+
+### How did we solve this ?
+
+Nova separates the gateway into multiple smaller components corresponding to each
+discord apis
+
+
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdiscordnova%2Fnova.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdiscordnova%2Fnova?ref=badge_large)