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

Update README.md

Browse source
This commit is contained in:
Silvano Cerza 2025-01-23 11:12:58 +01:00
parent 754418904a
commit 9b6a626944
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -5,6 +5,9 @@ Plugin to sync a GitHub repository with an Obsidian vault.
> [!CAUTION]
> This is still in beta.
I highly recommend not using this plugin with another sync service.
This might create problems for this plugin when determining what needs to be synced between remote repository and local vault.
## Features
These are the main features of the plugin:
@ -66,8 +69,6 @@ The `Sync with GitHub` command is also available.
If you want to sync your vault configs with other vault you can enable that.
It will sync the whole folder, that is `.obsidian` by default, including all plugins and themes.
If you use another sync service it might be best to disable this option.
> [!NOTE]
> The `.obsidian` folder will always be in the root of your repository, even if you choose
> to not sync vault configs. That happens cause the plugin needs to store some metadata to