docs: update README

Author: Vinzent03

README.md

@@ -1,101 +1,105 @@
-# Git
+# Obsidian Git Plugin
 
-A Community Plugin for [Obsidian.md](https://obsidian.md) to manage your vault with Git.
+A powerful community plugin for [Obsidian.md](Obsidian.md) that brings Git integration right into your vault. Automatically commit, pull, push, and see your changes — all within Obsidian.
 
-## Documentation
+## 📚 Documentation
 
-Requirements, installation steps (including setup for mobile), tips and tricks, common issues and more can be found in the [documentation](https://publish.obsidian.md/git-doc).
+All setup instructions (including mobile), common issues, tips, and advanced configuration can be found in the 📖 [full documentation](https://publish.obsidian.md/git-doc).
 
-For mobile users see [Mobile](#mobile) section below.
+> 👉 Mobile users: Please check the dedicated [Mobile](#mobile) section below.
 
-## Highlighted Features
+## ✨ Key Features
 
-- Automatic commit-and-sync (commit, pull and push) on a schedule.
-- Pull commits from remote repository on Obsidian startup.
-- Manage different repositories via Git submodules (Opt-in in settings) (Desktop only).
-- Stage, commit and diff individual files via the Source Control View. Open it with the `Open Source Control View` command.
-- List your commits and their changed files (like a `git log`) via the History View. Open it with the `Open History View` command.
-- For viewing the detailed history of a file, I strongly recommend you the [Version History Diff](obsidian://show-plugin?id=obsidian-version-history-diff) plugin.
+- 🔁 **Automatic commit-and-sync** (commit, pull, and push) on a schedule.
+- 📥 **Auto-pull on Obsidian startup**
+- 📂 **Submodule support** for managing multiple repositories (desktop only and opt-in)
+- 🔧 **Source Control View** to stage/unstage, commit and diff files - Open it with the `Open source control view` command.
+- 📜 **History View** for browsing commit logs and changed files - Open it with the `Open history view` command.
+- 🔍 **Diff View** for viewing changes in a file - Open it with the `Open diff view` command.
+- 🔗 GitHub integration to open files and history in your browser
 
-### Source Control View
+> 🧩 For detailed file history, consider pairing this plugin with the [Version History Diff](obsidian://show-plugin?id=obsidian-version-history-diff) plugin.
 
-This view allows you to stage, unstage individual files and commit them. It also shows the status of each file in your vault.
+## 🖥️ UI Previews
+
+### 🔧 Source Control View
+
+Manage your file changes directly inside Obsidian like stage/unstage individual files and commit them.
 
 ![Source Control View](https://raw.githubusercontent.com/Vinzent03/obsidian-git/master/images/source-view.png)
 
-### History View
+### 📜 History View
 
-This view shows the commit history of your repository. You can see the commit message, author, date, and changed files. Author and date are disabled by default as shown in the screenshot, but can be enabled in the settings.
+Show the commit history of your repository. The commit message, author, date, and changed files can be shown. Author and date are disabled by default as shown in the screenshot, but can be enabled in the settings.
 
 ![History View](https://raw.githubusercontent.com/Vinzent03/obsidian-git/master/images/history-view.png)
 
-### Diff View 
+### 🔍 Diff View 
 
-You can open the diff view from the source control view or via an extra command.
+Compare versions with a clear and concise diff viewer.
+Open it from the source control view or via the `Open diff view` command.
 
 ![Diff View](https://raw.githubusercontent.com/Vinzent03/obsidian-git/master/images/diff-view.png)
 
-## Available Commands (not exhaustive)
+## ⚙️ Available Commands
+> Not exhaustive - these are just some of the most common commands. For a full list, see the Command Palette in Obsidian.
 
-- Changes
+- 🔄 Changes
   - `List changed files`: Lists all changes in a modal
   - `Open diff view`: Open diff view for the current file
   - `Stage current file`
   - `Unstage current file`
-- Commit
+- ✅ Commit
   - `Commit all changes`: Only commits all changes without pushing
   - `Commit all changes with specific message`: Same as above, but with a custom message
   - `Commit staged`: Commits only files that have been staged
   - `Commit staged with specific message`: Same as above, but with a custom message
-- Commit-and-sync
+- 🔀 Commit-and-sync
   - `Commit-and-sync`: With default settings, this will commit all changes, pull, and push
   - `Commit-and-sync with specific message`: Same as above, but with a custom message
   - `Commit-and-sync and close`: Same as `Commit-and-sync`, but if running on desktop, will close the Obsidian window. Will not exit Obsidian app on mobile.
-- Remote
-  - `Push`
-  - `Pull`
+- 🌐 Remote
+  - `Push`, `Pull`
   - `Edit remotes`
   - `Remove remote`
   - `Clone an existing remote repo`: Opens dialog that will prompt for URL and authentication to clone a remote repo
   - `Open file on GitHub`: Open the file view of the current file on GitHub in a browser window. Note: only works on desktop
   - `Open file history on GitHub`: Open the file history of the current file on GitHub in a browser window. Note: only works on desktop
-- Local
+- 🏠 Manage local repository
   - `Initialize a new repo`
   - `Create new branch`
   - `Delete branch`
   - `CAUTION: Delete repository`
-- Source Control View
+- 🧪 Miscellaneous
   - `Open source control view`: Opens side pane displaying [Source control view](#sidebar-view)
   - `Edit .gitignore`
-  - `Add file to .gitignore`: Add current file to .gitignore
+  - `Add file to .gitignore`: Add current file to `.gitignore`
 
-## Desktop
+## 💻 Desktop Notes
 
-## Authentication
+### 🔐 Authentication
 
-Authentication may require additional setup. See more in the [Authentication documentation](https://publish.obsidian.md/git-doc/Authentication)
+Some Git services may require further setup for HTTPS/SSH authentication. Refer to the [Authentication Guide](https://publish.obsidian.md/git-doc/Authentication)
 
 ### Obsidian on Linux
 
-- ⚠ Snap is not supported.
-- ⚠ Flatpak is not recommended, because it doesn't have access to all system files.
-
-Please use AppImage instead ([Linux installation guide](https://publish.obsidian.md/git-doc/Installation#Linux))
-
-## Mobile
+- ⚠️  Snap is not supported.
+- ⚠️  Flatpak is not recommended, because it doesn't have access to all system files.
+- ✅ Please use AppImage or a full access installation of your system's package manager instead ([Linux installation guide](https://publish.obsidian.md/git-doc/Installation#Linux))
 
-The git implementation on mobile is **very unstable**!
+## 📱 Mobile Support (⚠️  Experimental)
 
-### Restrictions
+The Git implementation on mobile is **very unstable**! I would not recommend using this plugin on mobile, but try other syncing services.
+> 🧪 The Git plugin works on mobile thanks to [isomorphic-git](https://isomorphic-git.org/), a JavaScript-based re-implementation of Git - but it comes with serious limitations and issues. It is not possible for an Obsidian plugin to use a native Git installation on Android or iOS.
 
-The mobile version is supported by [isomorphic-git](https://isomorphic-git.org/), which is a re-implementation of Git in JavaScript, because you cannot use native Git on Android or iOS.
+### ❌ Mobile Limitations
 
-- SSH authentication is not supported ([isomorphic-git issue](https://github.com/isomorphic-git/isomorphic-git/issues/231))
-- Repo size is limited, because of memory restrictions
-- Rebase merge strategy is not supported
-- Submodules are not supported
+- No **SSH authentication** ([isomorphic-git issue](https://github.com/isomorphic-git/isomorphic-git/issues/231))
+- Limited repo size, because of memory restrictions
+- No rebase merge strategy
+- No submodules support
 
-### Performance on mobile
+### ⚠️  Performance Caveats
 
 > [!caution]
 > Depending on your device and available free RAM, Obsidian may
@@ -110,17 +114,17 @@ The mobile version is supported by [isomorphic-git](https://isomorphic-git.org/)
 
 The initial clone took 0m25s. After that, the most time consuming part is to check the whole working directory for file changes. On this setup, checking all files for changes to stage takes 03m40s. Other commands like pull, push and commit are very fast (1-5 seconds).
 
-The fastest way to work on mobile if you have a large repo/vault is to stage individual files and only commit staged files.
-
-## Contact
+### Tips for Mobile Use:
 
-The Line Authoring feature was developed by [GollyTicker](https://github.com/GollyTicker), so any questions may be best answered by him.
+The fastest way to work on mobile if you have a large repo/vault is to stage individual files and only commit staged files.
 
-If you have any kind of feedback or questions, feel free to reach out via GitHub issues or `vinzent3` on [Obsidian Discord server](https://discord.com/invite/veuWUTm).
+## 🙋 Contact & Credits
 
-This plugin was initial developed by [denolehov](https://github.com/denolehov). Since March 2021, it's me [Vinzent03](https://github.com/Vinzent03) who is developing this plugin. That's why the GitHub repository got moved to my account in July 2024.
+- The Line Authoring feature was developed by [GollyTicker](https://github.com/GollyTicker), so any questions may be best answered by him.
+- This plugin was initial developed by [denolehov](https://github.com/denolehov). Since March 2021, it's me [Vinzent03](https://github.com/Vinzent03) who is developing this plugin. That's why the GitHub repository got moved to my account in July 2024.
+- If you have any kind of feedback or questions, feel free to reach out via GitHub issues or `vinzent3` on [Obsidian Discord server](https://discord.com/invite/veuWUTm).
 
-## Support
+## ☕ Support
 
 If you find this plugin useful and would like to support its development, you can support me on Ko-fi.