I've been using your plugin for a few weeks and it's been great!
One mistake I made was pulling the 1.0.37-beta version of the plugin due to the CHANGELOG section of README.md making it look like that was the latest version rather than installing the plugin from within Obsidian. Obviously user error on my part, but I thought I'd offer a PR to make README.md clearer and ended up making a few more changes 🙃
What I changed (and thoughts on why):
README.md is shown when searching for community plugins within Obsidian. I think the user expectation here is more commonly to see how the plugin works rather than what changed recently
I moved the changelog to its own file as most users aren't going to be looking for what changed. As well, the changelog hasn't been kept up to date so moving it helps the user not think 1.0.38 is the latest version. Alternatively, moving the changelog to the bottom of README.md would also work
Added instructions on how to install the plugin from within Obsidian for users who, like me, forgot that's an easy option
Expanded on the Configuration instructions to match the style of the Installation instructions
Changed the wording under Contributing since the linked CONTRIBUTING.md file doesn't exist
Whitespace changes for uniformity
No worries if you don't like any of the changes -- just thought I'd make some suggestions 😄 :shipit:
I've been using your plugin for a few weeks and it's been great!
One mistake I made was pulling the 1.0.37-beta version of the plugin due to the
CHANGELOG
section ofREADME.md
making it look like that was the latest version rather than installing the plugin from within Obsidian. Obviously user error on my part, but I thought I'd offer a PR to makeREADME.md
clearer and ended up making a few more changes 🙃What I changed (and thoughts on why):
README.md
is shown when searching for community plugins within Obsidian. I think the user expectation here is more commonly to see how the plugin works rather than what changed recently1.0.38
is the latest version. Alternatively, moving the changelog to the bottom ofREADME.md
would also workConfiguration
instructions to match the style of theInstallation
instructionsContributing
since the linkedCONTRIBUTING.md
file doesn't existNo worries if you don't like any of the changes -- just thought I'd make some suggestions 😄 :shipit: