renamed README

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8737117
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# /u/SmallYTChannelBot Source Code
+
+The source code for /u/SmallYTChannelBot.
+
+# Docker
+
+- Clone the repo
+
+- Edit the configuration file and rename
+
+- Build the images:
+
+`sudo docker-compose build`
+
+- Start the containers:
+
+`sudo docker-compose up -d`
+
+# TODOs
+
+- [ ] Implement `!recheck` command to recheck already removed submissions
+
+- [ ] Ignore bot commands when they're formatted as code (` ` or indentation)
+
+- [ ] Write a bot for the discord
+
+- [ ] Implement a stream for edited comments
+
+# About the database's structure
+
+`users` is where usernames and the scores are kept. `lambdas` is for every
+time a lambda is given. Is linked to `users`. `stats` keeps unique users (just
+the amount of users in `users`), the total lambda in circulation (everyone's
+lambda scores summed), and the times help given, which is just the sum of every
+unique entry in `lambdas`. `blacklist` is the reddit id of every comment / 
+submission the bot has dealt with. If running on a new system you'll need to
+update this. You can do this using archive_posts.py