]> git.puffer.fish Git - matthieu/nova.git/commitdiff
add features, contributing and license. edit about nova
authoricecodder <47574874+icecodder@users.noreply.github.com>
Sat, 7 Aug 2021 09:36:12 +0000 (11:36 +0200)
committericecodder <47574874+icecodder@users.noreply.github.com>
Sat, 7 Aug 2021 09:36:12 +0000 (11:36 +0200)
README.md

index b2abaf4d2970a07250a020310133abbe607155d7..0492acc6f91eb28f8d92a14f85995942b5c7879a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,30 @@
 # Nova
 
-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 is an open source Discord framework for creating high-performance app.
 
-Nova builds upon Go and Rust to propose an effective, safe and production-ready solution.
+Nova builds upon [Go](https://github.com/golang/go) and [Rust](https://github.com/rust-lang/rust) with [Bazel](https://github.com/bazelbuild/bazel) to propose an effective, safe and production-ready solution.
 
-With Nova, you can be sure to have a reliable and effective Discord Bot.
+With Nova you can be sure to build reliable and efficient Discord bots.
 
-## Disclaimer
+### 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.
+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 and want to ensure excellent performance.
 
 ---
 
-## How its work
+## Features
 
-Behind Nova, there are many components :
+- ### Scalability
+- ### High-Performance
+- ### Reliability
+- ### Production-ready
 
-- cache
-- gateway
-- http-webhook
-- nats
-- ratelimit proxy
-- redis
-- rest-ratelimiter
+## Quick Start
 
----
+## Contributing
+
+If you wish to contribute to Nova, go to [CONTRIBUTING]().
+
+## License
+
+Nova is distributed under the Apache License 2.0, see [LICENSE](https://github.com/discordnova/nova/blob/main/LICENSE) for more information.