From 2aa6c949fb44f94b0d0a271157a38d466f2beb5b Mon Sep 17 00:00:00 2001 From: ransurf <80801637+ransurf@users.noreply.github.com> Date: Sat, 23 Oct 2021 14:54:50 -0600 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 92fc6d4..ce90528 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ # Habitica Sync in Obsidian This plugin for Obsidian incorporates a view to display and interact with the task management app Habitica. +Please open issues for any bugs/functionality requests :) + ## Usage -The plugin's view is enabled by clicking on the "Open Habitica Pane" option in the side ribbon. To sync your account, go to the settings page of the plugin and enter your user ID and API token credentials. +The plugin's view is enabled by clicking on the "Open Habitica Pane" option in the side ribbon (default hotkey is `Ctrl+Shift+H`). + +To sync your Habitica account, go to the settings page of the plugin and enter your user ID and API token credentials. ## Features -- View current HP and XP -- View todos, dailies, and habits -- Check off tasks/dailies in the view, which sync to habitica website -- Modify habit counters (+/-) +### Pane View +#### View HP, XP, todos, dailies, and habits +[![Image from Gyazo](https://i.gyazo.com/4266d01941e71fef41819ea8a6b6592e.png)](https://gyazo.com/4266d01941e71fef41819ea8a6b6592e) +[![Image from Gyazo](https://i.gyazo.com/697a58b8e7ffd3df86a2944b6abbaa92.png)](https://gyazo.com/697a58b8e7ffd3df86a2944b6abbaa92) +- Tab for active/completed tasks + +#### Check off tasks/dailies in the view, modify habit counters (+/-) +[![Image from Gyazo](https://i.gyazo.com/5759e12bc5267711c5e03485a6d72c2f.gif)](https://gyazo.com/5759e12bc5267711c5e03485a6d72c2f) +- Can uncheck completed habits/todos as shown above + ## Settings - **Habitica User ID:** You can find this by clicking on the "User" icon in the top right of the Habitica webapp, "Settings", then "API" - **Habitica Token API:** You can find this by clicking on the "User" icon in the top right of the Habitica webapp, "Settings", then "API" @@ -19,6 +29,6 @@ We will be implementing additional features including: - Add/delete/customize tasks and habits - View/claim rewards -Feeling generous? +*Feel free to support us and donate!* Buy Me a Coffee at ko-fi.com