Update README.md

This commit is contained in:
Jude Southworth 2020-10-02 14:19:53 +00:00 committed by GitHub
parent 817bcc72c1
commit 2b74adadeb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,14 @@
# reminder-rs
Reminder Bot for Discord, now in Rust
Reminder Bot for Discord, now in Rust.
Old Python version: https://github.com/reminder-bot/bot
## What is this?
This is a rewrite of Reminder Bot in Rust, using Serenity and SQLx amongst other libraries.
## Why is this?
Serenity and Rust are proving wonders for SoundFX. This is all in an effort to reduce resource consumption and improve performance.
## How do I use it?
You'll need rustc and cargo for compilation. To run, you'll need Python 3 still (due to no suitable replacement for dateparser in Rust)
TODO fill out the rest of this