readme

README.md

@@ -0,0 +1,32 @@
+# ench - sftp
+
+Edit your game-server files directly in VS Code or Cursor over SFTP.
+
+## Features
+
+- Connect with saved server profiles (up to 5), passwords stored in your OS keychain.
+- Browse the live server tree in the Explorer; folders load on demand.
+- Open a remote file to download it into `ench-sftp-cache/`; **Ctrl+S** uploads it back.
+- Auto-upload of open files on a timer (`sftp.autoUpload`, `sftp.syncIntervalSeconds`).
+- Conflict prompt when a file changes on the server: keep yours or load theirs.
+- Right-click a folder: **Load all files** (recursive download) or **Open files in workspace**.
+- **Open Remote File** quick picker (`Ctrl+Alt+O`).
+- Trusted-host allowlist and SSH host-key verification.
+
+## Settings
+
+- `sftp.autoUpload` — save and upload open files periodically (default on).
+- `sftp.syncIntervalSeconds` — server check / auto-upload interval, seconds (default 5, 0 = off).
+- `sftp.fileSearchExcludeGlobs` — folders hidden from browse/search (default `node_modules`, `.git`, `world`, `cache`, `alpine`).
+- `sftp.fileSearchMaxFiles` — cap for recursive load and quick-open search (default 5000).
+
+## Uninstall
+
+Uninstall, then fully quit and reopen the editor so the cleanup hook runs.
+Passwords in your OS keychain and `ench-sftp-cache/` folders remain until you remove them (use **Clear saved password** / **Disconnect**).
+**Open Remote File** (`Ctrl+Alt+O`) is available as a quick picker.
+
+## License
+
+This extension is licensed for use **only with ench services** ([ench.ro](https://ench.ro)). You may not use it as a general-purpose SFTP client or connect to third-party servers. Connection targets are restricted by a host allowlist maintained by ench; non-ench servers are blocked at connect time. First use requires accepting the terms of use.
+Proprietary — see [LICENSE](LICENSE). © 2026 ench.