Skip to content

Commit f1352f0

Browse files
committed
Update README with new features
1 parent 1632877 commit f1352f0

File tree

1 file changed

+43
-17
lines changed

1 file changed

+43
-17
lines changed

README.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ An Obsidian plugin that automatically commits vault changes to git.
55
## Features
66

77
- **Auto Commit**: Automatically commit changes after file modifications (with debounce)
8-
- **Manual Commit**: Commands for manual commit and push
8+
- **Auto Pull**: Optionally pull from remote when Obsidian opens
99
- **Auto Push**: Optionally push to remote after commit
10+
- **Manual Operations**: Commands for manual pull, commit, and push
11+
- **Conflict Detection**: Detect merge conflicts and pause auto-commit until resolved
12+
- **Git Status Badges**: Show colored dots next to modified/new files in file explorer
13+
- **Repository Management**: Initialize repo and configure remote URL from settings
1014
- **Custom Template**: Configurable commit message with variables
1115
- **File List**: Optionally include changed file list in commit body
1216
- **i18n**: English and Chinese UI support
@@ -16,7 +20,7 @@ An Obsidian plugin that automatically commits vault changes to git.
1620
### From GitHub Releases (Recommended)
1721

1822
1. Go to [Releases](https://github.com/whtiehack/obsidian-git-auto-commit/releases)
19-
2. Download `main.js` and `manifest.json` from the latest release
23+
2. Download `main.js`, `manifest.json`, and `styles.css` from the latest release
2024
3. Create folder `<vault>/.obsidian/plugins/auto-git-commit/`
2125
4. Copy downloaded files into the folder
2226
5. Restart Obsidian and enable the plugin in Settings → Community plugins
@@ -30,27 +34,61 @@ npm install
3034
npm run build
3135
```
3236

33-
Then copy `main.js` and `manifest.json` to your vault's plugin folder.
37+
Then copy `main.js`, `manifest.json`, and `styles.css` to your vault's plugin folder.
3438

3539
## Commands
3640

3741
| Command | Description |
3842
|---------|-------------|
39-
| `Auto Git Commit: Commit now` | Commit all changes immediately |
40-
| `Auto Git Commit: Commit and push` | Commit and push to remote |
43+
| `Commit now` | Commit all changes |
44+
| `Commit and push` | Commit and push to remote |
45+
| `Pull now` | Pull from remote |
46+
| `Push now` | Push to remote |
47+
| `Mark conflicts as resolved` | Mark conflicts as resolved (only shown when conflicts exist) |
4148

4249
## Settings
4350

51+
### Automation
52+
4453
| Option | Description | Default |
4554
|--------|-------------|---------|
55+
| Auto pull on open | Pull from remote when Obsidian opens | Off |
4656
| Enable auto commit | Auto commit after file changes | Off |
4757
| Debounce delay (seconds) | Wait time before committing | 30 |
4858
| Auto push after commit | Push to remote after commit | Off |
59+
60+
### Configuration
61+
62+
| Option | Description | Default |
63+
|--------|-------------|---------|
4964
| Commit message template | Custom message format | `vault backup: {{date}} {{time}}` |
5065
| Include file list in commit body | List changed files in body | On |
66+
| Show git status in file explorer | Display colored dots next to changed files | On |
5167
| Git binary path | Path to git executable | `git` |
5268
| Ignore .obsidian directory | Exclude config folder from triggers | On |
5369

70+
### Repository
71+
72+
- **Pull**: Pull from remote repository
73+
- **Commit**: Commit all changes
74+
- **Push**: Push to remote repository
75+
- **Remote URL**: Configure remote repository URL
76+
- **Initialize**: Initialize git repository (if not initialized)
77+
- **Resolve Conflicts**: Mark conflicts as resolved (only shown when conflicts exist)
78+
79+
## Git Status Badges
80+
81+
Colored dots are displayed next to files in the file explorer:
82+
83+
| Color | Status |
84+
|-------|--------|
85+
| 🟡 Yellow | Modified |
86+
| 🟢 Green | New/Added |
87+
| 🔴 Red | Deleted or Conflict |
88+
| 🔵 Blue | Renamed |
89+
90+
Folders show the highest priority status of their contents.
91+
5492
## Template Variables
5593

5694
| Variable | Description | Example |
@@ -60,18 +98,6 @@ Then copy `main.js` and `manifest.json` to your vault's plugin folder.
6098
| `{{files}}` | Changed files (max 5) | `a.md, b.md, ...` |
6199
| `{{count}}` | Number of changed files | `3` |
62100

63-
## Example Commit
64-
65-
With "Include file list" enabled:
66-
67-
```
68-
vault backup: 2025-12-20 10:30:00
69-
70-
notes/daily/2025-12-20.md
71-
attachments/image.png
72-
templates/note.md
73-
```
74-
75101
## Requirements
76102

77103
- Obsidian 1.2.0+

0 commit comments

Comments
 (0)