diff --git a/CHANGELOG.md b/CHANGELOG.md index e30115d..2eb9604 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,17 +5,17 @@ - **[ FEATURE ]** Add two new rounding options: `12m` and `20m`. (E.g., when using `klog start --round`.) -## v6.2 +## v6.2 (2023-10-17) - **[ FEATURE ]** Add new command `klog switch`, that stops a previously ongoing activity (open time range), and starts a new one. - **[ FEATURE ]** `klog start --resume` now falls back to the previous record for determining the last entry summary. -## v6.1 +## v6.1 (2023-05-01) - **[ FEATURE ]** Add new flag `klog start --resume`, which takes over the summary of the last entry for the new open-ended entry. -## v6.0 +## v6.0 (2023-03-06) - **[ BREAKING ]** The default location of the klog config folder has moved! So far, that folder only contains the bookmark database, so if you don’t use bookmarks, you can ignore this change. In order to see or configure the @@ -29,7 +29,7 @@ - **[ FEATURE ]** Display warning when using `--now` without there being any open-ended time range in the data. -## v5.4 +## v5.4 (2022-11-23) - **[ BREAKING ]** For `klog edit`, support if the `$EDITOR` variable contains additional flags, e.g. `vi -R` or `subl -w`. (If your editor path contains spaces, you now have to wrap it in quotes.) @@ -46,25 +46,25 @@ - **[ INFO ]** Significantly improve parsing performance for large data inputs (i.e., for files with 1000+ records). -## v5.3 +## v5.3 (2022-10-31) - **[ FEATURE ]** Optionally amend `klog print` output with total values via the `--with-totals` flag. - **[ FIX ]** Fix unhandled error edge-case in `klog report` command. -## v5.2 +## v5.2 (2022-08-19) - **[ FEATURE ]** Provide tab completion functionality for bash, zsh and fish shell. Run `klog completion` for setup instructions. - **[ FIX ]** `klog edit` handles when the `$EDITOR` variable contains spaces, and it also fails when `$EDITOR` is invalid. -## v5.1 +## v5.1 (2022-07-20) - **[ FEATURE ]** Optionally print out totals as decimal values (in minutes) via the `--decimal` flag; e.g. `150` instead of `2h30m`. - **[ FEATURE ]** Support `--now` on `klog tags` as well. - **[ FEATURE ]** Allow setting a record summary via the `--summary` flag when using `klog create`. -## v5.0 +## v5.0 (2022-04-13) - **[ META ]** Release the klog file format specification into the public domain (under the CC0/OWFa dual license). Read it here: https://github.com/jotaen/klog/blob/main/Specification.md @@ -75,7 +75,7 @@ - **[ FEATURE ]** For the `--period` flag, additionally allow filtering by quarter (`YYYY-Qq`, e.g. `2022-Q1`) and week (`YYYY-Www`, e.g. `YYYY-W34`). -## v4.0 +## v4.0 (2022-03-21) - **[ FEATURE ]** Allow summaries behind entries to be continued on the next line (with increased indentation level), e.g.: ``` @@ -100,7 +100,7 @@ convenience, via `klog --changelog`. - **[ BREAKING ]** Remove embedded macOS systray widget -## v3.3 +## v3.3 (2022-01-30) - **[ FEATURE ]** Allow times to be `24:00`, e.g. `22:00 - 24:00`. - **[ FEATURE ]** Add `klog goto` command for opening the file explorer at the location of a file or bookmark. @@ -111,7 +111,7 @@ - **[ FEATURE ]** Improve warnings (which are shown for potential data problems). - **[ FIX ]** Fix bug in week-based aggregation of `klog report --aggregate week`. -## v3.2 +## v3.2 (2021-11-30) - **[ BREAKING ]** Don’t allow mixing the indentation style within a record. (It might still differ *between* records, though.) For example: if the first entry is indented with a tab, then all further entries of that @@ -128,10 +128,10 @@ - **[ INFO ]** Deprecate the embedded native widget (for MacOS). It will be removed in one of the next releases. -## v3.1 +## v3.1 (2021-10-20) - **[ FIX ]** Fix stdin processing on Windows -## v3.0 +## v3.0 (2021-10-07) - **[ FEATURE ]** Support multiple (named) bookmarks to quickly reference often-used files, e.g. `klog total @work` - **[ FEATURE ]** Add additional evaluation options for `klog report` @@ -143,13 +143,13 @@ - **[ FEATURE ]** Support `klog --version` in addition to `klog version` - **[ FIX ]** Windows: don’t require admin privileges for setting bookmarks -## v2.6 +## v2.6 (2021-07-25) - **[ INFO ]** Release first version of the file format specification (v1.0) - **[ FIX ]** If a duration only contains a minute part, allow the value to be greater than 59, e.g. `120m`. -## v2.5 +## v2.5 (2021-05-17) - **[ BREAKING ]** Rename `klog now` to `klog today`; restructure the output, especially when using the `--diff`/`--now` flag - **[ FEATURE ]** Use distinct exit codes for different error cases @@ -157,7 +157,7 @@ - **[ FEATURE ]** Extend help texts, improve error messages - **[ FIX ]** Fix formatting issues of error output -## v2.4 +## v2.4 (2021-05-05) - **[ FEATURE ]** Automatically create a new record when doing `klog start` or `klog track` if there is no record yet - **[ FEATURE ]** Allow wildcard searching in tags by appending `...`, @@ -167,7 +167,7 @@ - **[ FIX ]** `klog stop --summary=""` doesn’t fail if the existing entry summary was empty -## v2.3 +## v2.3 (2021-04-28) - **[ FEATURE ]** Add `--summary`/`-s` flag for `start` and `stop` subcommands - **[ FEATURE ]** If `KLOG_DEBUG` environment variable is set, @@ -176,16 +176,16 @@ - **[ FIX ]** Display a more helpful error message on Windows to explain the quirks with `bookmark set` -## v2.2 +## v2.2 (2021-04-03) - **[ FEATURE ]** Provide `--no-style` option to disable output formatting (i.e. no colours, underlined, bold, etc.) - **[ FIX ]** Make sure that output formatting works on Windows across all Terminals. -## v2.1 +## v2.1 (2021-03-19) - **[ FEATURE ]** Provide native Windows binary -## v2.0 +## v2.0 (2021-03-16) - **[ BREAKING ]** Make `--after` and `--before` filters exclusive - **[ FEATURE ]** Add commands for manipulating files: - `create` for creating a new record @@ -196,20 +196,20 @@ - **[ FEATURE ]** Add `--period` filter (e.g. `--period=2015` for all in 2015, or `--period=2015-04` for all in April 2015). -## v1.6 +## v1.6 (2021-03-06) - **[ FEATURE ]** Add `json` subcommand that allows users to build programmatic extensions - **[ FEATURE ]** Support Windows line endings (`\r\n`) - **[ FEATURE ]** Add `bookmark unset` command for clearing current selection - **[ FEATURE ]** Check stdin for input (to allow shell piping) -## v1.5 +## v1.5 (2021-02-16) - **[ FIX ]** Fix the ongoing time counter in `klog now --follow` -## v1.4 +## v1.4 (2021-02-16) - **[ FIX ]** Fix the ongoing time counter in the MacOS widget -## v1.3 +## v1.3 (2021-02-14) - **[ BREAKING ]** Change structure of the bookmark subcommand (This is in order to account for the increasing number of operations) - **[ FEATURE ]** Add subcommand `now` for displaying an ongoing total @@ -227,12 +227,12 @@ - **[ FEATURE ]** Define shorthand flags, e.g. for `--now`, `--diff` - **[ FIX ]** Don’t demand `.klg` file extensions for bookmarks -## v1.2 +## v1.2 (2021-02-07) - **[ INFO ]** Provided more helpful error messages - **[ FIX ]** Fix unhandled error with experimental `template` subcommand (introduced in v1.1) -## v1.1 +## v1.1 (2021-02-07) - **[ INFO ]** Introduced hidden and experimental `template` subcommand, see https://github.com/jotaen/klog/pull/12 - **[ FIX ]** If a duration consists hours and minutes, @@ -240,7 +240,7 @@ - **[ FIX ]** Ensure there is a final blank line when `print`-ing - **[ FIX ]** Improve error messages regarding the bookmark subcommand -## v1.0 +## v1.0 (2021-02-06) - **[ BREAKING ]** Renamed subcommand `eval` to `total`. (This wording is more inline with the documentation and therefore more intuitive.) diff --git a/README.md b/README.md index d6bd0ff..16f5da9 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ klog is a plain-text file format and a command line tool for time tracking. -📕 [**Documentation**](https://klog.jotaen.net) – **Learn how to use klog** +📕 [**Documentation**](https://klog.jotaen.net) – **Learn what klog is and how to use it** 📥 [Install](https://klog.jotaen.net#get-klog) – Get the latest version 📢 [Changelog](https://github.com/jotaen/klog/blob/main/CHANGELOG.md) – See what’s new -💡 [Specification](Specification.md) – Understand the file format +💡 [Specification](Specification.md) – Study the file format ## Contribute @@ -27,7 +27,7 @@ they also have different version numbers. ## About klog was created by [Jan Heuermann](https://www.jotaen.net). -It is open-source software, which you are free to use under the following terms: +You are free to use it under the following terms: - Command line tool: [MIT license](LICENSE.txt) - File specification: [public domain (CC0/OWFa)](Specification.md#License)