PolyPaw/habitica-sync
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Semi-update readme

Browse source 
visuals are outdated
This commit is contained in:
ransurf 2021-11-21 01:47:32 -06:00 • committed by GitHub
parent ffa79454a0
commit 4878ed8aa8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -9,25 +9,30 @@ The plugin's view is enabled by clicking on the "Open Habitica Pane" option in t
To sync your Habitica account, go to the settings page of the plugin and enter your user ID and API token credentials.
## Features
### 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
- View stats (HP, XP, coins)
- View to do's, dailies, and habits
- Tab for active/completed tasks and dailies
#### 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
The following two inputs help fetch your user data to be displayed in the Obsidian view:
- **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"
The following two inputs help fetch your user data to be displayed in the Obsidian view.
**Show Task Descriptions:** Toggles whether description/notes for tasks will be shown or not
## Roadmap
We will be implementing additional features including:
- Add/delete/customize tasks and habits
- View/claim rewards
*Feel free to support us and donate!*