]> git.puffer.fish Git - matthieu/nova.git/commitdiff
add adaescription, disclaimer and explaination of how its work
authoricecodder <47574874+icecodder@users.noreply.github.com>
Fri, 6 Aug 2021 22:10:04 +0000 (00:10 +0200)
committericecodder <47574874+icecodder@users.noreply.github.com>
Fri, 6 Aug 2021 22:10:04 +0000 (00:10 +0200)
README.md

index 7a319c9d845421aa65afb97b4eb29ee85554179c..b2abaf4d2970a07250a020310133abbe607155d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,27 @@
 # Nova
 
-The futur of Bots on Discord!
+Nova is an open source Discord framework for creating fast, reliable high-performance app. It focus on scalability and distribued with system like K8s or Docker Swarm.
+
+Nova builds upon Go and Rust to propose an effective, safe and production-ready solution.
+
+With Nova, you can be sure to have a reliable and effective Discord Bot.
+
+## Disclaimer
+
+Nova requires a good infrastructure to operate and may consume lot of resources. Its not made for small Discord Bots but for those who are present on many servers while ensuring excellent performance.
 
 ---
-### Todo
 
-- [ ] README
+## How its work
+
+Behind Nova, there are many components :
+
+- cache
+- gateway
+- http-webhook
+- nats
+- ratelimit proxy
+- redis
+- rest-ratelimiter
+
+---