Skip to content

Commit e28b29e

Browse files
committed
doc: update docs & changelog
1 parent e15d20c commit e28b29e

File tree

4 files changed

+16
-5
lines changed

4 files changed

+16
-5
lines changed

docs/docs/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
## Unreleased
1414

15+
### ✨ Features
16+
17+
- You can now select where the plugin should store your API token.
18+
- By default, this is Obsidian's secret storage as this is the most secure option.
19+
- You may select the old file-based approach that was used prior to v2.5.0
20+
1521
### 🐛 Bug Fixes
1622

1723
- Task descriptions will now correctly be rendered if the `show` parameter of the query is omitted entirely.

docs/docs/configuration.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ There are a number of options that allow you to configure the behaviour of the p
88

99
## General
1010

11-
### Todoist API token
11+
### Token storage
1212

13-
The API token used to connect to Todoist. This is stored in your vault at `.obsidian/todoist-token`. If you synchronize your vault, I recommend that you do _not_ sync this file for security reasons.
13+
Controls where the plugin stores your Todoist API token. There are two options:
14+
15+
- **Obsidian secrets** - Uses Obsidian's built-in secret storage. This is the recommended option as it keeps your token out of your vault files.
16+
- **File-based** - Stores the token in a file at `.obsidian/todoist-token` inside your vault. If you synchronize your vault, you should consider _not_ syncing this file for security reasons. You may want to use this option if you have issues with Obsidian secrets.
17+
18+
Changing this setting will automatically migrate your token to the new storage location.
1419

1520
## Auto-refresh
1621

docs/docs/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Once the plugin is installed, you'll need to enable and do some initial setup.
2828
4. The prompt will verify that the token provided is valid and will present you with a checkmark if it is
2929
5. Select 'Save' to complete the setup
3030

31-
> Your API token is stored securely using Obsidian's built-in secret storage under the ID `swt-todoist-api-token`.
31+
> By default, your API token is stored securely using Obsidian's built-in secret storage. You can change this to file-based storage in the [plugin configuration](./configuration#token-storage).
3232
3333
## What's next?
3434

docs/docs/translation-status.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"total": 209,
2+
"total": 215,
33
"statuses": [
44
{
55
"name": "English",
66
"code": "en",
7-
"completed": 209
7+
"completed": 215
88
},
99
{
1010
"name": "Nederlands",

0 commit comments

Comments
 (0)