From e1d23704cfed8676a7f91d9c508d237815ea00d0 Mon Sep 17 00:00:00 2001
From: agatha <agatha@juggalol.com>
Date: Sat, 11 Nov 2023 11:27:05 -0500
Subject: [PATCH] Add installation and configuration to README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index c13eb46..7f8a96b 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,22 @@ search for API keys, passwords, endpoints, and more.
 
 GitMon will also build a table that maps commit email addresses to GitHub usernames.
 
+## Installation
+```shell
+git clone https://git.juggalol.com/agatha/gitmon
+cd gitmon
+pip install -r requirements.txt
+```
+
+## Configuration
+GitMon works best with a token. Without a token you are limited to 60 API calls per hour.
+Creating and using a Personal Access Token will raise that limit to 60,000 API calls per hour.
+
+To use a Personal Access Token, create a `config.py` file:
+```
+token = 'gh_YOUR_TOKEN_HERE'
+```
+
 ## Caught Slippin'
 ![Deleted GitHub token](.img/slippin-ght.png)