[Docs]: Need to add info regarding metadata refresh rate to the documentation

[OleksandrYuvkoExt]

Change Requested

Hi there, I wasn't fully aware about inner processes of plugin and how it actually work. The problem that I had was: when I add new tag, or whatever I can't find it and have to re-start obsidian. After some investigation I have found that shimmering-obsidian searches not through files but through extracted metadata by utilising kometenstaub/metadata-extractor. And metadata-extractor is refreshing metadata with default delay of 30 minutes(it can be configured), or after killing and launching Obsidian.

So it will be nice to have a brief description of shimmering-obsidian inner work on main page. And DEFINITELY documentation should have a description how to configure re-extraction delay.

Thank you!

Link to the relevant section of the documentation

https://github.com/chrisgrieser/shimmering-obsidian

[chrisgrieser]

The fact that the plugin uses the Metadata from the Metadata extractor plugin is mentioned here, including two methods on how to change the frequency. It is also mentioned here in the Trouble-shooting section.

Do you have any suggestion where else to add the information?

[OleksandrYuvkoExt]

@chrisgrieser It seems I am blind, sorry. It's just because plugin grown a lot(it's not bad) as well as documentation. But maybe it will be good to have brief overall explanation on main README page. Something like: This plugin offers search functionality by utilising metadata generated by kometenstaub/metadata-extractor plugin(not real time data). Refresh rate can be configured.

I am not too good in description, but you got it. The reason of !my mistake! was due to the fact that I thought that this is real time searching plugin(like spotlight or built in Alfred search). So maybe, it need to be added on title page, like in App Store or Google Store, something more that just: An Alfred Workflow with dozens of features for Obsidian.

[OleksandrYuvkoExt]

I mean initially it's just my problem, cause everything was in documentation, and it's an open source. Just trying to help newcomer's that are equally stupid as me 😄

[chrisgrieser]

Ah, good point, the information on that isn't findable if you are not actively looking for it in the configuration info page. I've added it here to the docs of the Quick Switcher-like features, since the metadata is only used by those features. 👍