Update project's documentation

[jsamuel1]

Is your feature request related to a problem? Please describe.
When the Obsidian Vault is not locally under an existing Syncthing folder path, there is no cue that the folders won't synchronize.

Describe the solution you'd like
When not located under an existing syncthing folder path, prompt to create a new folder syncronization in Syncthing or to associate with an existing remote folder.

This would improve the first-run experience.

Describe alternatives you've considered
Alternative would be first-install documentation.

[LBF38]

Hi, thanks for reporting the issue. I have to completely rewrite the documentation and the README to reflect the scope of this plugin.
As you've discovered, it doesn't provide any solution for "cloning" or syncing a Syncthing folder inside a current Obsidian vault.
Instead, this plugin aims at providing tools inside Obsidian to manage synced folders with Syncthing.

After some researches, I've found that it is too complicate (and also too heavy) to embed a Syncthing Instance inside Obsidian.
An alternative notetaking app to Obsidian based on Syncthing Any Sync Protocol would be https://github.com/anyproto/anytype-ts .

Therefore, I think the plugin is more focused on getting information from an active Syncthing instance on your device (PC, mobile or tablet) and provide you meaningful information about the status of the synchronization.
Such features are like the conflict files manager, the status bar feature, the settings to view the configuration. (still need time to make this better integrated. see #10)
I would also implement a Syncthing ignore files tool inside the settings, when I have more time. (see #81)

Hope these pieces of information help you. Feel free to reach out if something else isn't clear.

[jsamuel1]

100% -- This matched my expectations. Purely a documentation issue (as per your label).

[LBF38]

Fixed by #197