Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
File renamed without changes.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

---

Expand All @@ -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

---

Expand Down Expand Up @@ -202,13 +218,23 @@ 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
- **English**, **Deutsch**, and **Π‘ΡŠΠ»Π³Π°Ρ€ΡΠΊΠΈ**
- **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

---

Expand Down Expand Up @@ -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.

---

Expand All @@ -316,8 +338,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)
```

---
Expand Down
Loading