Add README.md
This commit is contained in:
		
							
								
								
									
										37
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										37
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,37 @@
 | 
				
			|||||||
 | 
					# Shitty Book Collector
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					A shitty CLI script to convert a `.ods` table into a `.html` table. It supports healthchecks and defining a CSS file.
 | 
				
			||||||
 | 
					That's it. Not much to see here.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Installation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Clone the project and move into the directory**
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					git clone https://github.com/moan0s/shitty-book-collector.git
 | 
				
			||||||
 | 
					cd shitty-book-collector/
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Optional: Create and activate a virtual environment**
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					python -m venv venv
 | 
				
			||||||
 | 
					source venv/bin/activate
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Install dependencies**
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					pip install -r requirements.txt
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Basic usage
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					python main.py -i Books.ods -o books.html
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Advanced usage
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					python main.py -i Books.ods -o books.html --css custom.css --healthcheck https://hc.example.org/ping/8acb905-1234-4567-7890-dac56fff
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
		Reference in New Issue
	
	Block a user