From 43357593a2cd4b4187011eea31648f9e1ef51a1b Mon Sep 17 00:00:00 2001 From: Bare7a Date: Thu, 18 Jun 2026 10:22:10 +0300 Subject: [PATCH 1/3] docs(XS-16): Update README and TESTING md files --- .github/CONTRIBUTING.md | 2 +- {test => .github}/TESTING.md | 0 README.md | 3 +-- 3 files changed, 2 insertions(+), 3 deletions(-) rename {test => .github}/TESTING.md (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8941b68..e45898e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -44,7 +44,7 @@ wails3 task dev ## ๐Ÿงช Testing -Before opening a PR, run the tests. See **[test/TESTING.md](../test/TESTING.md)** for full details. +Before opening a PR, run the tests. See **[TESTING.md](./TESTING.md)** for full details. ```bash # Frontend tests (React/TypeScript, Vitest) diff --git a/test/TESTING.md b/.github/TESTING.md similarity index 100% rename from test/TESTING.md rename to .github/TESTING.md diff --git a/README.md b/README.md index 7120d0d..4093d53 100644 --- a/README.md +++ b/README.md @@ -316,8 +316,7 @@ bin/XenSQL(.exe) # bin/XenSQL.app on macOS โ”‚ โ”œโ”€โ”€ storage/ # JSON persistence (incl. settings.json) โ”‚ โ”œโ”€โ”€ paths/ # Portable data directory โ”‚ โ””โ”€โ”€ service/ # SQL format, export helpers -โ”œโ”€โ”€ frontend/ # React + TypeScript + Monaco (Vitest tests) -โ””โ”€โ”€ test/ # TESTING.md - how to run all suites +โ””โ”€โ”€ frontend/ # React + TypeScript + Monaco (Vitest tests) ``` --- From 49363f5eae0c533b43ef7cece61a2855724c78e2 Mon Sep 17 00:00:00 2001 From: Bare7a Date: Thu, 18 Jun 2026 19:14:14 +0300 Subject: [PATCH 2/3] Updated Download section --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4093d53..31e1e71 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,21 @@ Just a focused, native desktop tool for working with databases. ## โฌ‡๏ธ Download -Grab the latest build for **Windows**, **macOS**, or **Linux** from the [**Releases**](../../releases/latest) page - no installer, no account, just download and run. +Grab the latest build for **Windows**, **macOS**, or **Linux** from the [**Releases**](../../releases/latest) page. + +### Recommended assets: +- **Windows**: `XenSQL-windows-amd64.zip` (portable) **or** `XenSQL-amd64-installer.exe` (installer) +- **Linux**: `XenSQL-linux-amd64.tar.gz` (portable) +- **macOS**: `XenSQL-darwin-arm64.zip` **or** `XenSQL-darwin-amd64.zip` (universal `.app`) + +### Additional options: +- **Windows**: `XenSQL.exe` (standalone) +- **Linux**: `xensql-x86_64.AppImage`, `.deb`, `.rpm`, `.pkg.tar.zst` +- **macOS**: `XenSQL-macos-universal.dmg` + +No account required - just download and run. + +Auto-update functionality works with the platform-specific `.zip`/`.tar.gz` assets listed above. Prefer to build it yourself? See **Installation & Development** below. @@ -41,7 +55,8 @@ Work with **SQLite**, **PostgreSQL**, and **MySQL / MariaDB** in a single fast d ๐Ÿงณ Portable โšก Fast startup ๐Ÿ”’ Local-first -๐Ÿง  Developer-focused +๐Ÿง  Developer-focused +๐Ÿ”„ Auto-updating --- @@ -53,6 +68,7 @@ Work with **SQLite**, **PostgreSQL**, and **MySQL / MariaDB** in a single fast d - Explore schemas instantly - Save and reuse queries - Export anything in one click +- **Auto-update** with one click --- @@ -202,6 +218,15 @@ View and modify table data directly in the grid - no hand-written `UPDATE` / `DE --- +## ๐Ÿ”„ Auto Updates + +- Automatically checks for new versions on startup +- Clean modal with changelog highlights +- One-click download and update +- Supports Windows (MSI), macOS, and Linux builds + +--- + ## ๐ŸŒ UX - **Dark & light** themes @@ -209,6 +234,7 @@ View and modify table data directly in the grid - no hand-written `UPDATE` / `DE - **Quick Search palette** (`Ctrl+P`) - jump to connections, saved queries, history, tabs - Custom shortcuts editor + keyboard tips - Frameless native title bar +- **Window state persistence** - size, position, and maximized state restored between sessions --- @@ -296,11 +322,7 @@ wails3 dev wails3 task build # or: wails3 task package (platform bundle/installer) ``` -Output: - -```text -bin/XenSQL(.exe) # bin/XenSQL.app on macOS -``` +The release pipeline now automatically produces cross-compiled Linux binaries and Windows MSI installers. --- From 0ecb3684d064120c03deef4a92ddb88805fe9de9 Mon Sep 17 00:00:00 2001 From: Bare7a Date: Fri, 19 Jun 2026 14:15:04 +0300 Subject: [PATCH 3/3] Updated README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 31e1e71..d734b35 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Work with **SQLite**, **PostgreSQL**, and **MySQL / MariaDB** in a single fast d - Explore schemas instantly - Save and reuse queries - Export anything in one click -- **Auto-update** with one click +- Auto-update with one click --- @@ -320,9 +320,6 @@ wails3 dev ```bash wails3 task build # or: wails3 task package (platform bundle/installer) -``` - -The release pipeline now automatically produces cross-compiled Linux binaries and Windows MSI installers. ---