From fb8cb90d2f6ab96e59e89907169fea89da39e9cf Mon Sep 17 00:00:00 2001
From: Matthew Adams <matt@matthewladams.com>
Date: Sat, 6 Mar 2021 14:34:12 +1000
Subject: [PATCH] Add README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52a5723
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# TikBot
+ A super simple Discord bot designed for helping you share TikToks without actually having to have your friends open TikTok.
+ 
+ TikBot will download any TikTok (or other supported link in youtube-dl) linked in a Discord channel it is in, and post the video file directly. 
+ In cases where the file is too large for Discord's free tier, the video will be compressed to fit first.
+ 
+ # Installation & Usage
+ Requirements: Python 2/3
+ 
+ 1. Set Discord access token into ```.env``` as ```TOKEN=$yourTokenGoesHere```
+ 
+ 2. Add the bot to the Discord server you wish to run it in.
+ 
+ 3. Setup any channel in the Discord server with a name starting with ```tik-tok```
+ 
+ 4. Ensure the bot has permission to post attachments and messages in the channel.
+ 
+ 5. Install required packages with ```pip install -r requirements.txt ```
+ 
+ 6. Run the bot ```python main.py```
+ 
+ # Notes
+ Not recommended to be available as a public bot due to the bandwidth and processing requirements of downloading and encoding videos.