Add installation and configuration to README.md
This commit is contained in:
		
							parent
							
								
									62cc40cdb4
								
							
						
					
					
						commit
						e1d23704cf
					
				
							
								
								
									
										16
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										16
									
								
								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'
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user