diff --git a/DESCRIPTION.md b/DESCRIPTION.md index 1a53504..385c623 100644 --- a/DESCRIPTION.md +++ b/DESCRIPTION.md @@ -32,3 +32,17 @@ A simple hosted notes app which features: - Cowboy code - Make assumptions - Go YOLO + +# CLI + +snotes TUI app + +- new CLI page on webapp gives instructions on installing the CLI: bash http://sno.tes/[user]/cli, the user allows the script to be customized upon download with both the userspace and the URL, such config is saved to ~/.config/snotes +- snotes command alone opens TUI with list, new options, pane with most recent notes, search, like webapp +- snotes [template] [date] opens a template dated [date] +- templates are defined like tags but using $ notation, so $journal in the note defines a journal template +- Template will have variable replacements, so if the first like is something like # Journal for %date%, the date [date] is inserted +- snotes recent shows a list of notes along with search +- snotes find (term) opens the search interface + +