diff --git a/README.md b/README.md index 55f71d9..45f336d 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# ByteDiceAssistant \ No newline at end of file + + +# ByteDiceAssistant +An automation tool for Byte Dice. It's both a Discord and Reddit bot in one program. + +This tool is not intended to be used publicly outside of the Byte Dice Assistant bots. Expect issues if you host this yourself. + +## Copyright +WIP!!! + +## How to run +*Dependecies:* You will need Rust (vi.d.k) and Python (vi.d.k) as well as these Python modules: +* WIP!!! + +To run, download the code and run `$ cargo run`. There are more options when running. You can view a list of those using `$ cargo run -- --help`. \ No newline at end of file