summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md25
-rw-r--r--TODO.md14
2 files changed, 36 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7a319c9..b2abaf4 100644
--- 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
+
+---
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..502d17c
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,14 @@
+# Todo
+
+## GitHub
+
+- PR and Issue template
+- Contributing GUIDE
+
+### Readme
+
+- Features
+- Explaination of each components
+- How to use (dev, prod)
+- Contributing
+- Sponsor? \ No newline at end of file