README.md in timetrap-1.10.0 vs README.md in timetrap-1.11.0

- old
+ new

@@ -299,11 +299,11 @@ **archive** Archives the selected entries (by moving them to a sheet called ``_[SHEET]``) These entries can be seen by running ``t display _[SHEET]``. - usage: ``t archive [--start DATE] [--end DATE] [SHEET]`` + usage: ``t archive [--start DATE] [--end DATE] [--grep REGEX] [SHEET]`` **backend** Run an interactive database session on the timetrap database. Requires the sqlite3 command. @@ -329,11 +329,11 @@ text. iCal, csv, json, and numeric id output are also supported. Display also allows the use of a ``--round`` or ``-r`` flag which will round all times in the output. See global options below. - usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [SHEET | all | full]`` + usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [--grep REGEX] [SHEET | all | full]`` **edit** Inserts a note associated with the an entry in the timesheet, or edits the start or end times. Defaults to the current entry, or previously running entry. An ``--id`` flag can be passed with the entry's id (see display.) @@ -452,11 +452,16 @@ **auto_sheet**: Which auto sheet module to use. **auto_sheet_search_paths**: an array of directories to search for user defined auto_sheet classes + **note_editor**: The command to start editing notes. Defaults to false which + means no external editor is used. Please see the section below + on Notes Editing for tips on using non-terminal based editors. + Example: note_editor: "vim" + ### Autocomplete Timetrap has some basic support for autocomplete in bash and zsh. There are completions for commands and for sheets. @@ -491,9 +496,20 @@ Then add this to source the completions: ```bash fpath=(/path/to/timetrap-1.x.y/gem/completions/zsh $fpath) ``` + +#### Notes editing +If you use the note_editor setting, then it is possible to use +an editor for writing your notes. If you use a non terminal based +editor (like atom, sublime etc.) then you will need to make timetrap +wait until the editor has finished. If you're using the "core.editor" +flag in git, then it'll be the same flags you'll use. + +As of when this command was added, for atom you would use `atom --wait` +and for sublime `subl -w`. If you use a console based editor (vim, emacs, +nano) then it should just work. Special Thanks -------------- The initial version of Timetrap was heavily inspired by Trevor Caira's