commit 38ebab021e99759f3ce2564d00036b0300f9a719
parent ef59d2651e5ad4cdabdbd51e3289172bea6c459b
Author: 442811 <42714028+dronesflier@users.noreply.github.com>
Date: Fri, 20 Feb 2026 13:24:27 +0100
Update README with images and usage clarifications
Added images and clarified installation instructions. Included a warning about trusting the code and improved the usage section.
Diffstat:
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -2,7 +2,9 @@
a tool that does what the obsidian client does with obsidian sync but without said obsidian client
+<img width="368" height="442" alt="grafik" src="https://github.com/user-attachments/assets/8bf43e28-bc42-40e7-b143-b74fce39c57a" />
+*yes that is my font*
## mandatory please dont scream at me or the robotgirls
@@ -14,6 +16,10 @@ i have to disclose something. this project was not programmed by hand. do not tr
that being said, i am actively using this and it works quite well. it's a cli plus systemd wrapper so you can just plug it into systemdearest and it'll sync in the background. it supports multiple (encrypted) vaults, logging into your account, and all the standard obsidian pushy pully just-a-fancy-git-repo-wrapper stuffies :b
+### why
+
+i needed a sync tool for backup reasons and other reasons™️that didnt involve a fucking chromium browser please fix @obsidian
+
## installation
```
@@ -36,7 +42,10 @@ the easiest way to get started is the interactive tui:
python setup_tui.py
```
-it'll walk you through logging in, picking a vault, setting a local path, and optionally installing a systemd service.
+it'll walk you through logging in, picking a vault, setting a local path, and optionally installing a systemd service. it looks really cool actually like im shocked at how well textual works i should use it more
+
+<img width="1098" height="580" alt="grafik" src="https://github.com/user-attachments/assets/57b99ba4-d5e4-45ed-9882-dfff4765aca4" />
+
if you prefer doing things by hand:
@@ -45,7 +54,7 @@ obsidian-sync login
obsidian-sync setup
```
-`login` will prompt for your email and password (and mfa code if you have that enabled (please dont have mfa enabled)). `setup` will list your vaults and ask which one you want, where to put it locally, your encryption password, and a device name.
+`login` will prompt for your email and password (and mfa code if you have that enabled (please dont have mfa enabled)). `setup` will list your vaults and ask which one you want, where to put it locally, your encryption password, and a device name
## usage
@@ -128,7 +137,7 @@ vault configs live at `~/.config/obsidian-sync/<VaultName>.json`. the fields:
| `sync_app_settings` | sync `.obsidian/` settings folder (default true) |
| `ignore_folders` | list of folder paths to skip |
-markdown, canvas, and base files are always synced. everything else is opt-in.
+markdown, canvas, and base files are always synced. everything else is opt-in
sync state is persisted to `<vault_path>/.obsidian/sync-state.json` between restarts so it doesn't have to re-examine everything from scratch each time.
