obsidian-plugin/silvanocerza_github-gitless-sync
1
0
Fork 0
mirror of https://github.com/silvanocerza/github-gitless-sync.git synced 2026-07-22 12:10:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README with FAQ section and clarify sync compatibility

Browse source
This commit is contained in:
Silvano Cerza 2025-04-14 18:14:26 +02:00
parent 32dee2db4c
commit de1c814260
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -102,7 +102,9 @@ If you need to reset the plugin settings and metadata you can easily do that in
That will completely wipe all the sync metadata so you'll have to repeat the first sync as if you just enabled the plugin for the first time.
## What's different from other sync plugins?
## FAQs
### What's different from other sync plugins?
There are obviously other plugins that let you sync your vault with GitHub or other git hosts, like [`obsidian-git`](https://github.com/Vinzent03/obsidian-git) and [`Obsidian-GitHub-Sync`](https://github.com/kevinmkchin/Obsidian-GitHub-Sync) just to name a couple.
@ -116,6 +118,14 @@ This obviously comes with some limitations. Since `git` is not used you can't in
Also since this relies only on the GitHub APIs you can only sync with GitHub and no other host.
### Can I use this with other sync plugins?
No.
To to work correctly this plugin uses a custom metadata file that is updated every time we sync, if you commit changes outside the plugin that file is not updated properly.
Other plugins don't know about that file, so if you sync with others too you risk breaking everything.
## License
The project is licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html) license.