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 with some info about logging

Browse source
This commit is contained in:
Silvano Cerza 2025-01-23 16:20:00 +01:00
parent ac1e53f79c
commit fa995a392e
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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