From 906dd3fb049bda4cbc6a42801b295437addfeab9 Mon Sep 17 00:00:00 2001 From: Infi Date: Mon, 16 Aug 2021 10:41:28 +0200 Subject: [PATCH] Update README to consistent format, closes #28 --- README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5b4f89d8..69d18c47 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,43 @@ -![](assets/banner.png) +# Delta -Delta is a **blazing fast API server** built with Rust for the REVOLT platform. +## Description + +Delta is a blazing fast API server built with Rust for REVOLT. + +**Features:** -Features: - Robust and efficient API routes for running a chat platform. - Distributed notification system, allowing any node to be seamlessly connected. - Simple deployment, based mostly on pure Rust code and libraries. - Hooks up to a MongoDB deployment, provide URI and no extra work needed. -## Docker Helper Scripts +## Stack + +- [Rocket](https://rocket.rs/) (REST) +- [Async Tungstenite](https://github.com/sdroege/async-tungstenite) (WebSockets) +- [MongoDB](https://mongodb.com/) + +## Resources + +### Revolt + +- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here) +- [Revolt Testers Server](https://app.revolt.chat/invite/Testers) +- [Contribution Guide](https://developers.revolt.chat/contributing) + +## CLI Commands + +### Docker Helper Scripts If you have Docker installed, you can use the helper scripts to deploy Revolt in your development environment. -```bash -./build.sh # build Docker image -./run.sh # run Docker container -./monitor.sh # view container logs -./remove.sh # kill and remove container -``` +| Command | Description | +| -------------- | -------------------------- | +| `./build.sh` | Build Docker Image. | +| `./run.sh` | Run Docker container. | +| `./monitor.sh` | View container logs. | +| `./remove.sh` | Kill and remove container. | + +## License + +Delta is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/delta/blob/master/LICENSE).