Skip to content

Commit

Permalink
more readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Heiss committed Jun 23, 2024
1 parent b69ef24 commit 2f92f2c
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

This **unofficial** plugin connects Obsidian and [Vikunja](https://vikunja.io). Vikunja is a todo-App and task manager
that helps you to organize your life. It can be used as a self-host replacement for [todoist.com](todoist.com/).
Synchronize with this plugin your vault with your Vikunja instance back and forth. It holds a lot of settings to
customize it to your workflow needs.
Synchronize your tasks with your Vikunja instance back and forth. It holds a lot of settings to
adjust it to your workflow needs.

Per default, this plugin only runs on manual trigger. In settings you can find a setting to enable automatic sync, also
Per default, this plugin only runs on manual trigger. In settings, you can find a setting to enable automatic sync, also
the interval can be set there. All tasks will be pushed to vikunja on first sync and stay in sync.

This plugin depends on some other plugins to work: (subject to change with later updates)
Expand All @@ -18,6 +18,38 @@ The experience with this plugin is a lot like the excellent plugins for todoist:
- [Ultimate Todoist Sync for Obsidian Plugin](https://github.com/HeroBlackInk/ultimate-todoist-sync-for-obsidian)
- [Obsidian Todoist Plugin](https://github.com/jamiebrynes7/obsidian-todoist-plugin)

## Features

Every feature prioritizes the Obsidian side. If a task is updated in both systems, the Obsidian task will be the one who
wins. So it is currently not recommended to use Vikunja and Obsidian at the same time to update tasks or in team work.

| Feature | -> Vikunja | <- Vikunja | Description |
|-----------------------------|------------|------------|--------------------------------------------|
| Add task ||| |
| Update task ||| |
| Delete task ||| No way to find the deleted vikunja tasks. |
| Modify task title ||| |
| Modify task description | 🚧 | 🚧 | |
| Modify assigned labels/tags ||| |
| Modify due date ||| |
| Mark task as done/undone ||| |
| Sync done date ||| |
| Set task priority | 🚧 | 🚧 | |
| Modify task priority | 🚧 | 🚧 | |
| Add task to project | ✅(1) | 🚧 | (1) Only the default project is supported. |
| Update assigned project | 🚧 | 🚧 | |
| Move tasks between files || - | |

✅= done and usable, 🚧=not yet implemented but under development, ❌=not possible or will not come

Supported Task Formats:

- [Emoji Task Format](https://publish.obsidian.md/tasks/Reference/Task+Formats/Tasks+Emoji+Format)

Supported Vault Searching Implementations:

- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)

## Bugs

### Wrong timezone configured on device or vikunja instance
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "vikunja-sync",
"name": "Vikunja Sync",
"version": "1.0.0",
"version": "1.0.1",
"minAppVersion": "0.15.0",
"description": "Integrates Vikunja into Obsidian as Task Management Platform.",
"author": "Peter Heiss",
Expand Down

0 comments on commit 2f92f2c

Please sign in to comment.