Update README.md
This commit is contained in:
		
							parent
							
								
									97d0141f05
								
							
						
					
					
						commit
						dc15b9bf72
					
				
							
								
								
									
										112
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										112
									
								
								README.md
									
									
									
									
									
								
							| @ -52,16 +52,126 @@ This section explains the thorough use of each procedure. | ||||
| * [Show notes](#search-notes) | ||||
| 
 | ||||
| ### Create a note | ||||
| `rnote new` can be simplified by `rnote n`.\ | ||||
| In order to create a note, type: | ||||
| ``` | ||||
| $ rnote new | ||||
| ``` | ||||
| It will prompt you to enter a note name and a note will be saved in date-named category.\ | ||||
| Or | ||||
| ``` | ||||
| $ rnote new <name> | ||||
| ``` | ||||
| Same as previous but without prompt.\ | ||||
| Or | ||||
| ``` | ||||
| $ rnote new <name> <category> | ||||
| ``` | ||||
| It will create a note `<name>` in `<category>`. | ||||
| 
 | ||||
| ### Edit a note | ||||
| `rnote edit` can be simplified by `rnote e`.\ | ||||
| In order to edit a note, type: | ||||
| ``` | ||||
| $ rnote edit | ||||
| ``` | ||||
| It will prompt you to enter a note name.\ | ||||
| Or | ||||
| ``` | ||||
| $ rnote edit <name> | ||||
| ``` | ||||
| It will search all notes named `<name>` and will prompt you to choose one if multiple notes found.  | ||||
| 
 | ||||
| ### List notes | ||||
| `rnote list` can be simplified by `rnote ls` or `rnote l`.\ | ||||
| You can list all notes by typing: | ||||
| ``` | ||||
| $ rnote list | ||||
| ``` | ||||
| It will show you all notes and prompt to optionnaly choose one to open.\ | ||||
| You can also list all notes from a `<category>` by typing: | ||||
| ``` | ||||
| $ rnote list -c | ||||
| ```  | ||||
| or | ||||
| ``` | ||||
| $ rnote list --category | ||||
| ``` | ||||
| It will prompt you to enter category name. | ||||
| 
 | ||||
| ### Remove notes | ||||
| 
 | ||||
| `rnote remove` can be simplified by `rnote r`.\ | ||||
| To delete a note, you can simply type: | ||||
| ``` | ||||
| $ rnote remove | ||||
| ``` | ||||
| It will prompt you to enter a name of a note. | ||||
| Or | ||||
| ``` | ||||
| $ rnote remove <name> | ||||
| ``` | ||||
| Both commands will prompt if you do want to delete a note.\ | ||||
| \ | ||||
| You can also remove all notes created at a certain date with: | ||||
| ``` | ||||
| $ rnote remove -d | ||||
| ``` | ||||
| Or  | ||||
| ``` | ||||
| $ rnote remove --date | ||||
| ``` | ||||
| Which will prompt to enter a date in the format `YYYY-mm-dd`. | ||||
| ### Search notes | ||||
| `rnote search` can be simplified by `rnote s`.\ | ||||
| To search a note simply type: | ||||
| ``` | ||||
| $ rnote search | ||||
| ``` | ||||
| Or | ||||
| ``` | ||||
| $ rnote search <name> | ||||
| ``` | ||||
| First one will prompt you to enter the name.\ | ||||
| \ | ||||
| You can also search by word/string containing in some note: | ||||
| ``` | ||||
| $ rnote search -w | ||||
| ``` | ||||
| or | ||||
| ``` | ||||
| $ rnote search --word | ||||
| ``` | ||||
| It will prompt to enter a string to search in all notes and will prompt you to choose one if multiple notes found. | ||||
| 
 | ||||
| ### Show notes | ||||
| To show a note, type: | ||||
| ``` | ||||
| $ rnote show | ||||
| ``` | ||||
| Or | ||||
| ``` | ||||
| $ rnote show <name> | ||||
| ``` | ||||
| It will show a note in a scrollable TextView in a raw terminal.\ | ||||
| To scroll use arrow keys or mouse. To quit click on any button.\ | ||||
| \ | ||||
| To show all notes, use flag `--all`: | ||||
| ``` | ||||
| $ rnote show --all | ||||
| ``` | ||||
| Or | ||||
| ``` | ||||
| $ rnote show -a | ||||
| ``` | ||||
| To show all notes from a `<category>`, use flag `--category`: | ||||
| ``` | ||||
| $ rnote show -c | ||||
| ``` | ||||
| Or | ||||
| ``` | ||||
| $ rnote show --category | ||||
| ``` | ||||
| It will prompt you to enter category name. | ||||
| 
 | ||||
| ## TODO | ||||
| 
 | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Volodymyr Patuta
						Volodymyr Patuta