mark-when/obsidian-plugin

Add usage guide in readme

hikomoon opened this issue · 2 comments

What would you like to be added?

a simple usage demo. or address of how to write mw files.

Why is this needed?

I am a heavy user of obsidian. When I was looking for a Gantt chart plugin to manage my project more efficiently, I found your build of obsidian-plugin. The screenshot of readme is amazing. This is what I want.

But I meet a problem when trying to use it. I don’t know what markwhen file is, and I don’t know how to start using it. After some Internet searches, I found this document https://docs.markwhen.com/

For users like me who searched for this plugin directly through obsidian, can you add some usage descriptions to the readme? This may greatly reduce the time users spend confused.

Thank you very much for your building!

+1. @hikomoon I also struggled with getting started. FYI you create a new mw file by clicking the Markwhen icon on the side bar after installation.

This is such an amazing plugin. The only thing holding it back is a quick getting started guide. The tool itself might benefit from affordances that guide the user into discovering its features and how to use them to make amazing timelines.