From 63a223bf24488102eac130f7af6af85cde9e9b63 Mon Sep 17 00:00:00 2001
From: socks <me@sockspls.com>
Date: Tue, 9 Mar 2021 02:30:40 +0000
Subject: [PATCH] Created README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9640069
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Discord bot to track stock portfolios
+
+## Install Guide
+
+First, install dependencies and clone repo
+```sh
+# Required Dependencies
+sudo apt install git python3.8 python pipenv
+
+# Clone Repository
+git clone git@git.sockspls.com:kate/stock-tracker-discord.git
+```
+
+Recommended: Install [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/) (Otherwise, flat file is used)
+
+Then, create pipenv environment
+```sh
+cd stock-tracker-discord
+pipenv install
+```
+
+Setup config file
+```sh
+cp config.example.py config.py
+nano config.py
+```
+
+Run script
+```sh
+pipenv run main.py
+```