Update README.md

2025-02-14 09:52:49 +01:00
parent 5f420a4fd0
commit 1c8af8ff17
1 changed files with 15 additions and 1 deletions
@@ -1 +1,15 @@
-# ByteDiceAssistant
+<!-- TODO: stylize -->
+
+# 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`.