From fa995a392ea65b71de83838f452b002eb6ecf1a4 Mon Sep 17 00:00:00 2001 From: Silvano Cerza Date: Thu, 23 Jan 2025 16:20:00 +0100 Subject: [PATCH] Update README.md with some info about logging --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c5e224..74b1c62 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,18 @@ Plugin to sync a GitHub repository with an Obsidian vault. > [!CAUTION] -> This is still in beta. +> This is still in beta, logging is enabled by default. +> I suggest you don't disable for the time being while using the plugin +> as the logging information might be useful to fix some issues. 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. +### Issues + +If you find any problem please open an issue with as many details as possible. +If could include the `github-sync.log` file found in your config directory that would be very helpful. + ## Features These are the main features of the plugin: @@ -81,7 +88,7 @@ needs to store some metadata to correctly sync I still have to add a reset button to clean the plugin settings and metadata. For the time being you can reset the plugin by disabling it in the plugins list and deleting the `github-sync-metadata.json` -file in your config directory, `.obsidian` by default. +and `github-sync.log` files in your config directory, `.obsidian` by default. ## License