diff --git a/README.md b/README.md index 63a1626..855744c 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,29 @@ Tiny RDM is a modern lightweight cross-platform Redis desktop manager available for Mac, Windows, and Linux. -![](screenshots/light_en.png) +![](screenshots/dark_en.png) ## Feature -* Built on Webview, no embedded browsers (Thanks to [Wails](https://github.com/wailsapp/wails)). -* More elegant UI and visualized layout (Thanks to [Naive UI](https://github.com/tusen-ai/naive-ui) +* Super lightweight, built on Webview2, without embedded browsers (Thanks to [Wails](https://github.com/wailsapp/wails)). +* More elegant UI, frameless, offering light and dark themes (Thanks to [Naive UI](https://github.com/tusen-ai/naive-ui) and [IconPark](https://iconpark.oceanengine.com)). -* Multi-language support (Click here to contribute and support more languages). -* Convenient data viewing and editing. -* More features under continuous development... +* Multi-language support ([Need more languages ? Click here to contribute](.github/CONTRIBUTING.md)). +* Better connection management: supports SSH Tunnel/SSL/Sentinel Mode/Cluster Mode. +* Visualize key value operations, CRUD support for Lists, Hashes, Strings, Sets, Sorted Sets, and Streams. +* Support multiple data viewing format and decode/decompression methods. +* Operation command execution logs. +* Provides command-line operations. + +## Roadmap +- [ ] Pagination and querying for List/Hash/Set/Sorted Set +- [ ] Decode/decompression display for value of List/Hash/Set/Sorted Set +- [ ] Slow logs +- [ ] Real-time commands monitoring +- [ ] Pub/Sub operations ## Installation -We publish binaries for Mac, Windows, and Linux. Available to download for free from [here](https://github.com/tiny-craft/tiny-rdm/releases). > If you can't open it after installation on macOS, exec the following command then reopen: @@ -34,9 +43,9 @@ Available to download for free from [here](https://github.com/tiny-craft/tiny-rd > sudo xattr -d com.apple.quarantine /Applications/Tiny\ RDM.app > ``` -## Build +## Build Guidelines ### Prerequisites -* Go >= 1.21 +* Go (latest version) * Node.js >= 16 * NPM >= 9 diff --git a/README_zh.md b/README_zh.md index b6a6a73..4c8bfaa 100644 --- a/README_zh.md +++ b/README_zh.md @@ -13,14 +13,14 @@ 一个现代化轻量级的跨平台Redis桌面客户端,支持Mac、Windows和Linux -![screenshot](screenshots/light_zh.png) +![screenshot](screenshots/dark_zh.png) ## 功能特性 * 极度轻量,基于Webview2,无内嵌浏览器(感谢[Wails](https://github.com/wailsapp/wails)) -* 更精美的界面和直观的结构布局(感谢[Naive UI](https://github.com/tusen-ai/naive-ui) +* 更精美的界面,无边框窗口,提供浅色/深色主题(感谢[Naive UI](https://github.com/tusen-ai/naive-ui) 和 [IconPark](https://iconpark.oceanengine.com)) -* 多国语言支持:英文/中文(点我贡献和完善多国语言支持) +* 多国语言支持:英文/中文([需要更多语言支持?点我贡献语言](.github/CONTRIBUTING_zh.md)) * 更好用的连接管理:支持SSH隧道/SSL/哨兵模式/集群模式 * 可视化键值操作,增删查改一应俱全 * 支持多种数据查看格式以及转码/解压方式 @@ -29,6 +29,7 @@ ## 未来版本规划 - [ ] List/Hash/Set/Sorted Set的分页展示和查询 +- [ ] List/Hash/Set/Sorted Set值的转码显示 - [ ] 慢日志展示 - [ ] 命令实时监控 - [ ] 发布/订阅支持 diff --git a/frontend/README.md b/frontend/README.md index b4719be..3ac7d13 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,8 +1,3 @@ -# Vue 3 + Vite +# Frontend of Tiny RDM -This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `