Skip to content

Commit fa995a3

Browse files
committed
Update README.md with some info about logging
1 parent ac1e53f commit fa995a3

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,18 @@
33
Plugin to sync a GitHub repository with an Obsidian vault.
44

55
> [!CAUTION]
6-
> This is still in beta.
6+
> This is still in beta, logging is enabled by default.
7+
> I suggest you don't disable for the time being while using the plugin
8+
> as the logging information might be useful to fix some issues.
79
810
I highly recommend not using this plugin with another sync service.
911
This might create problems for this plugin when determining what needs to be synced between remote repository and local vault.
1012

13+
### Issues
14+
15+
If you find any problem please open an issue with as many details as possible.
16+
If could include the `github-sync.log` file found in your config directory that would be very helpful.
17+
1118
## Features
1219

1320
These are the main features of the plugin:
@@ -81,7 +88,7 @@ needs to store some metadata to correctly sync
8188
I still have to add a reset button to clean the plugin settings and metadata.
8289

8390
For the time being you can reset the plugin by disabling it in the plugins list and deleting the `github-sync-metadata.json`
84-
file in your config directory, `.obsidian` by default.
91+
and `github-sync.log` files in your config directory, `.obsidian` by default.
8592

8693
## License
8794

0 commit comments

Comments
 (0)