Merge branch 'modify-readme' into 'main'
Update README.md See merge request paris8-rust/rnote!1
This commit is contained in:
		
						commit
						75dfe7df16
					
				
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
								
							@ -8,24 +8,26 @@ A minimal note taking cli tool.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Description
 | 
					## Description
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**rnote** creates files in a date-named directories with a name of a header of the note. 
 | 
					**rnote** creates `Markdown` text files in a date-named or category directories with a name of a header of the note. 
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Example:
 | 
					Example:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
.rnote/
 | 
					.rnote/
 | 
				
			||||||
├── 2020-03-20
 | 
					├── 2020-03-20
 | 
				
			||||||
│   └── Lockdown
 | 
					│   └── Lockdown.md
 | 
				
			||||||
└── 2020-10-20
 | 
					├── 2020-10-20
 | 
				
			||||||
    └── New Lockdown
 | 
					│   └── New Lockdown.md
 | 
				
			||||||
 | 
					└── shop
 | 
				
			||||||
 | 
					    └── to buy.md
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## TODO
 | 
					## TODO
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- [ ] Create a note
 | 
					- [ ] Create a note
 | 
				
			||||||
- [ ] Delete a note
 | 
					- [ ] Delete a note
 | 
				
			||||||
- [ ] Show all notes
 | 
					- [ ] Modify a note
 | 
				
			||||||
- [ ] Show all notes from `DATE`
 | 
					- [ ] Show all notes in a scrollable TextView in a raw terminal with [termimad](https://crates.io/crates/termimad)
 | 
				
			||||||
 | 
					- [ ] Show all notes from `DATE` or `Category`
 | 
				
			||||||
- [ ] Search a note by header
 | 
					- [ ] Search a note by header
 | 
				
			||||||
- [ ] Search a note by word
 | 
					- [ ] Search a note by word (kinda grep)
 | 
				
			||||||
- [ ] Export a note to `.md` format 
 | 
					 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user