README.md in timetrap-1.3.0 vs README.md in timetrap-1.4.0

- old
+ new

@@ -1,15 +1,20 @@ Timetrap ======== -Timetrap is a utility which provides an easy to use command line interface for -tracking what you spend your time on. It is a ruby port of Trevor Caira's -Timebook, a small python utility. It contains several enhancement over -Timebook notably the ability to parse natural language time strings. This -makes commands such as ``t in --at "30 minutes ago"`` possible. Timetrap is -also able to export entries to several formats (e.g. ical, csv) and is designed -to be easily extended to support additional export formats. +Timetrap is a simple command line time tracker written in ruby. It provides an +easy to use command line interface for tracking what you spend your time on. + +It began as a ruby port of Trevor Caira's Timebook, a small python utility. It +contains several enhancement over Timebook, notably the ability to parse +natural language times (e.g. "30 minutes ago"), additional commands such as +`archive` and `configure`, and support for rounding. + +Timetrap is also able to export entries to several formats (e.g. ical, csv) and +is designed to be easily extended to support additional export formats, by +creating a new formatter class (in ruby.) + Timetrap maintains its state in a sqlite3 database. Timetrap is available as a gem on gemcutter (http://gemcutter.org/gems/timetrap) To install: @@ -33,11 +38,11 @@ time sheet may only have one period running at once. Interactions with timetrap are performed through the ``t`` command on the command line. ``t`` is followed by one of timetrap's subcommands. Often used subcommands include ``in``, ``out``, ``switch``, ``now``, ``list`` and -``display``. Commands may be abbreviated as long as they are unambiguous: thus +``display``. *Commands may be abbreviated as long as they are unambiguous.* thus ``t switch foo`` and ``t s foo`` are identical. With the default command set, no two commands share the first same letter, thus it is only necessary to type the first letter of a command. Likewise, commands which display timesheets accept abbreviated timesheet names. ``t display f`` is thus equivalent to ``t display foo`` if ``foo`` is the only timesheet which begins with "f". Note that @@ -103,11 +108,12 @@ usage: ``t backend`` **configure** Creates a config file at ``~/.timetrap.yml`` or ``ENV['TIMETRAP_CONFIG_FILE']`` if one doesn't exist. Prints path to config file. Currently allows configuration - of path to database file. + of path to database file, and the number of seconds used when the `--round` + flag is set (defaults to 15 minutes.) usage: ``t configure`` **display** Display a given timesheet. If no timesheet is specified, show the current @@ -118,11 +124,11 @@ Display is designed to support a variety of export formats that can be specified by passing the ``--format`` flag. This currently defaults to text. iCal and csv output are also supported. Display also allows the use of a ``--round`` or ``-r`` flag which will round - all times to 15 minute increments. See global options below. + all times in the output. See global options below. usage: ``t display [--ids] [--round] [--start DATE] [--end DATE] [--format FMT] [SHEET | all]`` **edit** Inserts a note associated with the an entry in the timesheet, or edits the @@ -187,9 +193,11 @@ **rounding** passing a ``--round`` or ``-r`` flag to any command will round entry start and end times to the closest 15 minute increment. This flag only affects the display commands (e.g. display, list, week, etc.) and is non-destructive. The actual start and end time stored by Timetrap are unaffected. + + See `configure` command to change rounding increment from 15 minutes. Configuration -------- Configuration of TimeTrap's behavior can be done through a YAML config file.