From 97d0141f05323341049f2e810a788235de9be660 Mon Sep 17 00:00:00 2001 From: Volodymyr Patuta <90917-fiplox@users.noreply.framagit.org> Date: Sat, 12 Dec 2020 17:26:39 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index 401fbb5..5101c5a 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,50 @@ Example: └── to buy.md ``` +## Basic usage +`rnote` gives certain subcommands for managing your notes. +``` +USAGE: + rnote [SUBCOMMAND] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + edit Edit a note. + help Prints this message or the help of the given subcommand(s) + list List all notes or notes from a category. + new Create new note + panic Delete all notes. + remove Remove a note. + search Search a note. + show Show note(s) in TextView. +``` +You can get help page to each subcommand individually by typing `rnote -h` to see all possible options. + +## Usage +This section explains the thorough use of each procedure. + +* [Create a note](#create-a-note) +* [Edit a note](#edit-a-note) +* [List notes](#list-notes) +* [Remove notes](#remove-notes) +* [Search notes](#search-notes) +* [Show notes](#search-notes) + +### Create a note + +### Edit a note + +### List notes + +### Remove notes + +### Search notes + +### Show notes + ## TODO - [x] Create a note From dc15b9bf729ae23e65ee776a546c59d4b2ccc0f6 Mon Sep 17 00:00:00 2001 From: Volodymyr Patuta <90917-fiplox@users.noreply.framagit.org> Date: Sat, 12 Dec 2020 17:59:40 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 111 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5101c5a..06924a3 100644 --- a/README.md +++ b/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 +``` +Same as previous but without prompt.\ +Or +``` +$ rnote new +``` +It will create a note `` in ``. ### 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 +``` +It will search all notes named `` 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 `` 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 +``` +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 +``` +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 +``` +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 ``, use flag `--category`: +``` +$ rnote show -c +``` +Or +``` +$ rnote show --category +``` +It will prompt you to enter category name. ## TODO