docs: update README with new features, badges, and contributors (#36)

* feat: support drag-and-drop preview for Parquet, CSV, TSV, JSON files Uses DuckDB in-memory connection with read_parquet()/read_csv()/read_json(). No sidebar connection created, tab title shows file name only, connection/database toolbar hidden for preview tabs. * feat: update README and README.zh-CN with badges and new features; bump version to 0.2.1
2026-10-28 09:45:37 +08:00 · 2026-04-30 18:10:44 +08:00
1 parent 7e858296cd
commit 355164f20e
@@ -2,6 +2,13 @@
  <img src="docs/logo.png" width="80" />
  <h1>DBX</h1>
  <p>Open-source, lightweight, cross-platform database management tool.</p>
+  <p>
+    <a href="https://github.com/t8y2/dbx/releases"><img src="https://img.shields.io/github/v/release/t8y2/dbx?label=version" /></a>
+    <a href="https://github.com/t8y2/dbx/releases"><img src="https://img.shields.io/github/downloads/t8y2/dbx/total" /></a>
+    <a href="https://github.com/t8y2/dbx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/t8y2/dbx" /></a>
+    <a href="https://github.com/t8y2/dbx/graphs/contributors"><img src="https://img.shields.io/github/contributors/t8y2/dbx" /></a>
+    <a href="https://linux.do"><img src="https://img.shields.io/badge/community-LINUX%20DO-blue" /></a>
+  </p>
  <p>
    <img src="https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white" />
    <img src="https://img.shields.io/badge/PostgreSQL-4169E1?logo=postgresql&logoColor=white" />
@@ -11,6 +18,7 @@
    <img src="https://img.shields.io/badge/DuckDB-FFF000?logo=duckdb&logoColor=black" />
    <img src="https://img.shields.io/badge/ClickHouse-FFCC01?logo=clickhouse&logoColor=black" />
    <img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoftsqlserver&logoColor=white" />
+    <img src="https://img.shields.io/badge/Oracle-F80000?logo=oracle&logoColor=white" />
    <img src="https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white" />
    <img src="https://img.shields.io/badge/TiDB-DC150B?logo=tidb&logoColor=white" />
  </p>
@@ -21,19 +29,21 @@

 ## Features

- **Multi-database** — MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KingBase, Vastbase, GoldenDB
- **Schema browser** — Databases, schemas, tables, columns, indexes, foreign keys, triggers
- **Query editor** — CodeMirror 6 with syntax highlighting, Cmd+Enter execution, Cmd+scroll zoom
+- **Multi-database** — MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KingBase, Vastbase, GoldenDB
+- **Schema browser** — Databases, schemas, tables, columns, indexes, foreign keys, triggers, with sidebar search & pin
+- **Query editor** — CodeMirror 6 with syntax highlighting, SQL autocomplete (tables & columns), Cmd+Enter execution, selected SQL execution, SQL formatting
 - **AI SQL assistant** — Natural language to SQL, explain, optimize, fix errors (Claude / OpenAI)
 - **Data grid** — Virtual-scrolled table with inline editing, sorting, search, pagination, column resize, row numbers, zebra stripes
 - **Export** — CSV, JSON, Markdown
- **Redis browser** — Key pattern search, value viewer for all data types (String, Hash, List, Set, ZSet)
- **MongoDB browser** — Document CRUD with pagination
+- **File preview** — Drag & drop Parquet, CSV, JSON files to preview data instantly (powered by DuckDB)
+- **Redis browser** — Key pattern search, value viewer for all data types (String, Hash, List, Set, ZSet, Stream)
+- **MongoDB browser** — Document CRUD with pagination, direct URL connection (Atlas, replica sets)
 - **Query history** — Persistent history with search, restore, one-click copy
 - **Safety** — Confirmation dialog for DROP / DELETE / TRUNCATE / ALTER
 - **Auto-reconnect** — Transparent retry on connection loss
 - **SSH tunnel** — Key and password authentication
- **File drag & drop** — Drag .db / .sqlite / .duckdb files to open directly
+- **Connection colors** — Color-coded connections for visual identification
+- **Auto-update** — Built-in update checker with release notifications
 - **Dark mode** — Native title bar theme sync
 - **i18n** — English & 简体中文
 - **Tiny** — ~15 MB installer (no bundled Chromium)
@@ -48,6 +58,19 @@

 Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases) page.

+**Homebrew (macOS):**
+
+```bash
+brew install --cask t8y2/tap/dbx
+```
+
+**Scoop (Windows):**
+
+```bash
+scoop bucket add dbx https://github.com/t8y2/scoop-bucket
+scoop install dbx
+```
+
 ### macOS Note

 DBX is not signed with an Apple Developer certificate. On first launch, macOS will block the app. To fix this:
@@ -91,6 +114,12 @@ The installer will be in `src-tauri/target/release/bundle/`.
 | Editor    | [CodeMirror 6](https://codemirror.net/)                                                                                                                                                                          |
 | Backend   | Rust + [sqlx](https://github.com/launchbadge/sqlx) / [tiberius](https://github.com/prisma/tiberius) / [redis-rs](https://github.com/redis-rs/redis-rs) / [mongodb](https://github.com/mongodb/mongo-rust-driver) |

+## Contributors
+
+<a href="https://github.com/t8y2/dbx/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=t8y2/dbx" />
+</a>
+
 ## License

 [MIT](LICENSE)
@@ -2,6 +2,13 @@
  <img src="docs/logo.png" width="80" />
  <h1>DBX</h1>
  <p>开源、轻量、跨平台的数据库管理工具。</p>
+  <p>
+    <a href="https://github.com/t8y2/dbx/releases"><img src="https://img.shields.io/github/v/release/t8y2/dbx?label=version" /></a>
+    <a href="https://github.com/t8y2/dbx/releases"><img src="https://img.shields.io/github/downloads/t8y2/dbx/total" /></a>
+    <a href="https://github.com/t8y2/dbx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/t8y2/dbx" /></a>
+    <a href="https://github.com/t8y2/dbx/graphs/contributors"><img src="https://img.shields.io/github/contributors/t8y2/dbx" /></a>
+    <a href="https://linux.do"><img src="https://img.shields.io/badge/community-LINUX%20DO-blue" /></a>
+  </p>
  <p>
    <img src="https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white" />
    <img src="https://img.shields.io/badge/PostgreSQL-4169E1?logo=postgresql&logoColor=white" />
@@ -11,6 +18,7 @@
    <img src="https://img.shields.io/badge/DuckDB-FFF000?logo=duckdb&logoColor=black" />
    <img src="https://img.shields.io/badge/ClickHouse-FFCC01?logo=clickhouse&logoColor=black" />
    <img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoftsqlserver&logoColor=white" />
+    <img src="https://img.shields.io/badge/Oracle-F80000?logo=oracle&logoColor=white" />
    <img src="https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white" />
    <img src="https://img.shields.io/badge/TiDB-DC150B?logo=tidb&logoColor=white" />
  </p>
@@ -21,19 +29,21 @@

 ## 功能特性

- **多数据库** — MySQL、PostgreSQL、SQLite、Redis、MongoDB、DuckDB、ClickHouse、SQL Server、MariaDB、TiDB、OceanBase、openGauss、GaussDB、KingBase、Vastbase、GoldenDB
- **结构浏览** — 数据库、Schema、表、字段、索引、外键、触发器
- **查询编辑器** — CodeMirror 6 语法高亮、Cmd+Enter 执行、Cmd+滚轮缩放
+- **多数据库** — MySQL、PostgreSQL、SQLite、Redis、MongoDB、DuckDB、ClickHouse、SQL Server、Oracle、MariaDB、TiDB、OceanBase、openGauss、GaussDB、KingBase、Vastbase、GoldenDB
+- **结构浏览** — 数据库、Schema、表、字段、索引、外键、触发器，支持侧边栏搜索和置顶
+- **查询编辑器** — CodeMirror 6 语法高亮、SQL 自动补全（表名和字段）、Cmd+Enter 执行、选中 SQL 执行、SQL 格式化
 - **AI SQL 助手** — 自然语言生成 SQL、解释、优化、修复错误（Claude / OpenAI）
 - **数据表格** — 虚拟滚动、行内编辑、排序、搜索、分页、列宽调整、行号、斑马纹
 - **数据导出** — CSV、JSON、Markdown
- **Redis 浏览器** — 模式匹配搜索，支持全部数据类型（String、Hash、List、Set、ZSet）
- **MongoDB 浏览器** — 文档增删改查、分页浏览
+- **文件预览** — 拖入 Parquet、CSV、JSON 文件即时预览数据（基于 DuckDB）
+- **Redis 浏览器** — 模式匹配搜索，支持全部数据类型（String、Hash、List、Set、ZSet、Stream）
+- **MongoDB 浏览器** — 文档增删改查、分页浏览，支持 URL 直连（Atlas、副本集）
 - **查询历史** — 持久化存储，支持搜索、恢复、一键复制
 - **安全防护** — 执行 DROP / DELETE / TRUNCATE / ALTER 时弹出确认对话框
 - **自动重连** — 连接断开后透明重试
 - **SSH 隧道** — 支持密钥和密码两种认证方式
- **文件拖放** — 拖拽 .db / .sqlite / .duckdb 文件到窗口直接打开
+- **连接颜色** — 为连接设置颜色标记，快速区分环境
+- **自动更新** — 内置版本检查，新版本自动提醒
 - **深色模式** — 原生标题栏主题同步
 - **多语言** — English & 简体中文
 - **极致轻量** — 安装包约 15 MB（不内嵌 Chromium）
@@ -48,6 +58,19 @@

 从 [Releases](https://github.com/t8y2/dbx/releases) 页面下载最新版本。

+**Homebrew (macOS)：**
+
+```bash
+brew install --cask t8y2/tap/dbx
+```
+
+**Scoop (Windows)：**
+
+```bash
+scoop bucket add dbx https://github.com/t8y2/scoop-bucket
+scoop install dbx
+```
+
 ### macOS 说明

 DBX 未使用 Apple 开发者证书签名，首次打开时 macOS 会阻止运行。解决方法：
@@ -91,6 +114,12 @@ pnpm tauri build
 | 编辑器 | [CodeMirror 6](https://codemirror.net/) |
 | 后端 | Rust + [sqlx](https://github.com/launchbadge/sqlx) / [tiberius](https://github.com/prisma/tiberius) / [redis-rs](https://github.com/redis-rs/redis-rs) / [mongodb](https://github.com/mongodb/mongo-rust-driver) |

+## 贡献者
+
+<a href="https://github.com/t8y2/dbx/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=t8y2/dbx" />
+</a>
+
 ## 开源协议

 [MIT](LICENSE)