Skip to content

Commit 450c906

Browse files
committed
docs: update README with new settings
- Add badge refresh interval setting - Add debug logging setting
1 parent bf378ea commit 450c906

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,11 @@ Then copy `main.js`, `manifest.json`, and `styles.css` to your vault's plugin fo
7272
| Commit message template | Custom message format | `vault backup: {{date}} {{time}}` |
7373
| Include file list in commit body | List changed files in body | On |
7474
| Show git status in file explorer | Display colored dots next to changed files | On |
75+
| Badge refresh interval (seconds) | Detect external git changes. Set to 0 if you only use Obsidian | 0 |
7576
| Show ribbon button | Add Git actions menu to left ribbon | On |
7677
| Git binary path | Path to git executable | `git` |
77-
| Ignore .obsidian directory | Exclude config folder from triggers | On |
78+
| Ignore config directory | Exclude Obsidian config folder from triggers | On |
79+
| Debug logging | Log git commands to console (Ctrl+Shift+I to view) | Off |
7880

7981
### Setup (for new users)
8082

README_zh.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,11 @@ npm run build
7272
| 提交消息模板 | 自定义消息格式 | `vault backup: {{date}} {{time}}` |
7373
| 在提交正文中包含文件列表 | 在正文中列出变更文件 | 开启 |
7474
| 在文件列表显示 Git 状态 | 在变更文件旁显示彩色圆点 | 开启 |
75+
| 状态刷新间隔(秒) | 检测外部 git 操作。若只在 Obsidian 内操作可设为 0 | 0 |
7576
| 显示侧边栏按钮 | 在左侧功能区添加 Git 菜单 | 开启 |
7677
| Git 可执行文件路径 | git 的路径 | `git` |
7778
| 忽略配置目录 | 排除配置文件夹触发自动提交 | 开启 |
79+
| 调试日志 | 将 git 命令输出到控制台(Ctrl+Shift+I 查看) | 关闭 |
7880

7981
### 初始设置(新用户)
8082

0 commit comments

Comments
 (0)