chore: update readme
This commit is contained in:
		
							parent
							
								
									d06a6cecb6
								
							
						
					
					
						commit
						2baae8ee68
					
				
					 1 changed files with 33 additions and 5 deletions
				
			
		
							
								
								
									
										38
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										38
									
								
								README.md
									
										
									
									
									
								
							|  | @ -1,17 +1,45 @@ | ||||||
| # eolas-db | # eolas-db | ||||||
| 
 | 
 | ||||||
| This application parses data in my [zettelkasten](https://github.com/thomasabishop/eolas) repository and populates an | This CLI application parses entries in my | ||||||
| SQLite database that records key metadata about each entry (tags, backlinks, outlinks etc). | [zettelkasten](https://github.com/thomasabishop/eolas) and extracts key metadata | ||||||
| 
 | about each entry. It create and populates an SQLite database to store the data and derive | ||||||
| It exposes a command line application for interfacing with the database. | relations between entries. | ||||||
| 
 | 
 | ||||||
| ## Local development | ## Local development | ||||||
| 
 | 
 | ||||||
| ``` | ``` | ||||||
| source venv/bin/activate | source venv/bin/activate | ||||||
| eolas-db | eolas-db [opts] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | ## Production | ||||||
|  | 
 | ||||||
|  | After development is complete, instead of compiling to a single executable I can just install the application | ||||||
|  | with `pipx` like any other. | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | pipx install [local_path_to_application] | ||||||
|  | eolas-db [opts] | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | ### Update after changes | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | pipx uninstall eolas-db | ||||||
|  | pipx install [local_path_to_application] | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | ## Options | ||||||
|  | 
 | ||||||
|  | ### `populate` | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | eolas-db populate | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | Parse Eòlas entries and extract key metadata and body text, import into database | ||||||
|  | tables. | ||||||
|  | 
 | ||||||
| ## ERM | ## ERM | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		
		Reference in a new issue
	
	 thomasabishop
						thomasabishop