docs: update the readme with more details (#63)

Signed-off-by: Andrew Brandt <andrew.brandt@hashgraph.com>

Author: andrewb1269

README.md

@@ -3,20 +3,35 @@
 # VersionTwo
 Hackathon project: CLI tool to generate static planning view of issues for better team planning
 
-# Problem we are solving
-GitHub projects users are unable to easily associate issues across organizations with a project and particularly find having to manually add issues to the project board itself as a time consuming unnecessarily difficult task.
-
-We propose improving this interface by adding a simple HTTP page with an interactive Kanban which is able to aggregate a user provided selection of repos, projects, organizations and display them in a filterable way.
-
-# Getting Started
-## Requirements and Setup
-The following items are required to run the program.
+# 🚀 Getting Started
+## 📦 Requirements
+The following dependencies are required to run the program:
 - Python 3.x
+  - `brew install python3`
 - Python `pyenv` and `pyenv-virtualenv`
   -  `brew install pyenv pyenv-virtualenv`
 - GitHub Command Line Interface (CLI) `gh`
+  - `brew install gh`
+
+## 💻 Setup
 - Authentication through `gh auth login`
-  - Set the appropriate token permissions: `gh auth refresh --scopes read:project`
+- Set the appropriate token permissions: `gh auth refresh --scopes read:project`
+- Run `make install` inside the repo directory to configure the appropriate versions of dependencies.
+
+## 🛠 Usage
+To run the main script, change to the current directory of the script, then run:
+
+`python version2.py --output-file "<filename.json>" --temp-dir "<temp.dir>" --include-team <teamname>`
+
+See the `--help` menu for full list of filter functionality.
 
-Run `make install` inside the repo directory to configure the appropriate versions of dependencies.
+# Background
+GitHub users have issues assigned to themselves or a team they are a member of. These issues can be viewed on a 
+Project board, which captures the issues in swim lanes. The Project board can only automate with a single organization,
+meaning users who work in more than one org do not have a single location to view all issues. This leads to fragmented
+planning and execution.
 
+# Our Solution
+Our python script will query the GitHub API for all issues associated with the appropriate filters provided to the CLI
+tool. The output will be a static HTML page showing all issues in swim lanes. This provides a comprehensive overview
+of all issues the team or user has assigned.