From 977abb01bdbcd13fff7e1d954d1019735a89295e Mon Sep 17 00:00:00 2001 From: Jamie Brynes Date: Thu, 1 Feb 2024 19:45:01 +0000 Subject: [PATCH] update readme & changelog --- CHANGELOG.md | 1 + README.md | 8 +++----- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d4e939..a3fd6cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix intent level to match standard markdown levels in order to have consistent style. - Aligned the grouping behaviour with Todoist's when grouping by project. This will be expanded on in a future release. - Changed all icons to be part of the Lucide set to align with Obsidian. +- The `title` part of the query is now optional. ## [1.11.1] - 2023-04-09 diff --git a/README.md b/README.md index 6e2e8e8..282847c 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ The query is defined in YAML and accepts the following keys: | Name | Required | Description | Type | Default | | ------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ | -| `name` | ✓ | The title for the materialized query. You can use the `{task_count}` template which will be replaced by the number of tasks returned by the query. | string | | +| `name` | | The title for the materialized query. You can use the `{task_count}` template which will be replaced by the number of tasks returned by the query. | string | "" | | `filter` | ✓ | A valid [Todoist filter](https://get.todoist.help/hc/en-us/articles/205248842-Filters)[1](#footnote-1) | string | | | `autorefresh` | | The number of seconds between auto-refreshing. If omitted, the query use the default global settings. | number | null | | `sorting` | | Describes how to order the tasks in the query. Can be any of 'priority', 'dateAscending' (aliased as 'date'), 'dateDescending', or multiple of these. | string[] | [] | @@ -75,7 +75,7 @@ show: There are also a few commands bundled in with the plugin: -1. 'Refresh Metadata' +1. 'Sync with Todoist' This command refreshes all the metadata (projects, sections, and labels) for Todoist tasks. This is done at startup. @@ -85,14 +85,12 @@ There are also a few commands bundled in with the plugin: 3. 'Add Todoist task with the current page' - Similiar to the previous command, this one also appends a link to the current active page to the task input. + Similar to the previous command, this one also appends a link to the current active page to the task input. ## CSS This plugin comes with default CSS intended for use with the default Obsidian themes. -I also maintain an Obsidian theme which has support out of the box for this plugin, for a complete example of CSS for this plugin, check out [the source](https://github.com/jamiebrynes7/moonlight-obsidian-theme/blob/master/src/modules/extensions/todoist.scss). - --- 1: There are some exceptions in the Todoist API. Checkout [this issue](https://github.com/jamiebrynes7/obsidian-todoist-plugin/issues/34) for details.