Skip to content

Commit fe94037

Browse files
committed
docs: emphasize desktop-only and minimal design philosophy
1 parent 9a6afed commit fe94037

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
English | [中文](README_zh.md)
44

5-
An Obsidian plugin that automatically commits vault changes to git.
5+
A lightweight Obsidian plugin that automatically commits vault changes to git. **Desktop only**.
6+
7+
> **Design Philosophy**: This plugin stays minimal and focused. It does one thing well: automatic git commits. No bloat, no complexity—just simple, reliable version control for your notes.
68
79
## Features
810

@@ -120,9 +122,11 @@ Folders show the highest priority status of their contents.
120122
## Requirements
121123

122124
- Obsidian 1.2.0+
123-
- Desktop only (git not available on mobile)
125+
- **Desktop only** (Windows / macOS / Linux)
124126
- Git installed and accessible
125127

128+
> **Why no mobile support?** Mobile platforms lack native Git. While [isomorphic-git](https://github.com/isomorphic-git/isomorphic-git) exists, it has significant limitations: CORS restrictions requiring proxy servers, Buffer compatibility issues, and severe performance problems (large repos can take 100+ seconds or crash). We'll revisit mobile support when isomorphic-git matures.
129+
126130
## License
127131

128132
MIT

README_zh.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[English](README.md) | 中文
44

5-
一个自动将 Obsidian 仓库变更提交到 Git 的插件。
5+
一个轻量级的 Obsidian 插件,自动将仓库变更提交到 Git。**仅支持桌面端**
6+
7+
> **设计理念**:本插件保持克制,专注核心功能。只做好一件事:自动 Git 提交。无臃肿、无复杂——为你的笔记提供简单可靠的版本控制。
68
79
## 功能
810

@@ -120,9 +122,11 @@ npm run build
120122
## 系统要求
121123

122124
- Obsidian 1.2.0+
123-
- 仅支持桌面端(移动端不支持 Git
125+
- **仅支持桌面端**(Windows / macOS / Linux
124126
- 已安装并可访问 Git
125127

128+
> **为何不支持移动端?** 移动平台没有原生 Git。虽然有 [isomorphic-git](https://github.com/isomorphic-git/isomorphic-git),但它存在明显限制:CORS 限制需要代理服务器、Buffer 兼容性问题、以及严重的性能问题(大型仓库可能需要 100 多秒或直接崩溃)。等 isomorphic-git 更成熟后我们会重新考虑移动端支持。
129+
126130
## 许可证
127131

128132
MIT

0 commit comments

Comments
 (0)