From e1505917633665892bfe5657e801d31b36f38ee0 Mon Sep 17 00:00:00 2001
From: Vaclav Tvrdik <vt@vaclavt.cz>
Date: Wed, 30 Sep 2026 11:06:35 +0200
Subject: [PATCH] Add GitHub-based install instructions and Package Control
 repository.json

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
---
 README.md       | 41 +++++++++++++++++++++++++++++++++--------
 repository.json | 21 +++++++++++++++++++++
 2 files changed, 54 insertions(+), 8 deletions(-)
 create mode 100644 repository.json

diff --git a/README.md b/README.md
index 6941afa..9b7eba6 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,42 @@ Requires Sublime Text 4 with the Python 3.8 plugin host (build 4149+, for
 
 ## Install
 
-Symlink this folder into Sublime packages as `vterm`:
+### With Package Control
 
-```sh
-ln -s /Users/vaclavt/devel/vt/vterm "$HOME/Library/Application Support/Sublime Text/Packages/vterm"
+vterm is not on the default channel, so add its repository first. Open
+**Preferences → Package Settings → Package Control → Settings** and put the URL
+below in the `repositories` array of the right-hand (User) pane:
+
+```json
+{
+    "repositories": [
+        "https://raw.githubusercontent.com/vaclavt/vterm/main/repository.json"
+    ]
+}
 ```
 
-Dependencies (pyte, ptyprocess, wcwidth) are Package Control libraries declared
-in `dependencies.json`. If they are not yet in `Lib/python38` (e.g. Terminus was
-never installed), run **Package Control: Satisfy Libraries** and restart Sublime.
-Package Control garbage-collects libraries no package requires, so if imports
-ever fail after uninstalling another package, re-run *Satisfy Libraries*.
+Then run **Package Control: Install Package** from the Command Palette and pick
+**vterm**. Upgrades arrive through **Package Control: Upgrade Package** like any
+other package.
+
+### From source
+
+Clone the repository into the Sublime Text `Packages` directory as `vterm`:
+
+```sh
+git clone https://github.com/vaclavt/vterm.git \
+  "$HOME/Library/Application Support/Sublime Text/Packages/vterm"
+```
+
+Use one method or the other, not both: an unpacked `Packages/vterm` directory
+overrides the `vterm.sublime-package` that Package Control installs.
+
+Either way, dependencies (pyte, ptyprocess, wcwidth) are Package Control
+libraries declared in `dependencies.json`. If they are not yet in
+`Lib/python38` (e.g. Terminus was never installed), run **Package Control:
+Satisfy Libraries** and restart Sublime. Package Control garbage-collects
+libraries no package requires, so if imports ever fail after uninstalling
+another package, re-run *Satisfy Libraries*.
 
 ## Use
 
diff --git a/repository.json b/repository.json
new file mode 100644
index 0000000..ae3763b
--- /dev/null
+++ b/repository.json
@@ -0,0 +1,21 @@
+{
+    "$schema": "sublime://packagecontrol.io/schemas/repository",
+    "schema_version": "4.0.0",
+    "packages": [
+        {
+            "name": "vterm",
+            "details": "https://github.com/vaclavt/vterm",
+            "description": "Minimalist terminal for Sublime Text 4, built to run TUI coding agents (pi, claude) in a tab",
+            "author": "vaclavt",
+            "labels": ["terminal", "shell", "pty"],
+            "releases": [
+                {
+                    "sublime_text": ">=4149",
+                    "platforms": ["osx"],
+                    "python_versions": ["3.8"],
+                    "tags": true
+                }
+            ]
+        }
+    ]
+}