agatha/gitmon
1
Fork 0
mirror of https://git.juggalol.com/agatha/gitmon.git synced 2024-12-26 23:56:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add installation and configuration to README.md

Browse Source
This commit is contained in:
agatha 2023-11-11 11:27:05 -05:00
parent 62cc40cdb4
commit e1d23704cf
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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)