search

LBF38 / obsidian-syncthing-integration

Obsidian plugin for Syncthing integration
MIT License
152 stars 6 forks source link

[DOCS] Improve documentation to include setup instructions #213

Open LennartCode opened 2 months ago

LennartCode commented 2 months ago

Currently, just installing Syncthing and enabling the extension is not sufficient to set up the plugin. One has to update the PATH (on Windows at least, don't know about other OS's), copy the API key and depending on the Syncthing setup change other settings, which are currently undocumented. As a lot of Obsidian users are not very tech-savvy, I would like to add documentation to help setting everything up for a standard Syncthing installation. Please let me know, if this would be a welcome contribution :)

PS: There wasn't a template for documentation issues, so I made this up. I hope this is okay.

LBF38 commented 2 months ago

Hi, thanks for opening an issue on documentation. Feel free to contribute on this topic if you've got time. Thanks in advance !