doc: update README
27
README.md
|
@ -13,20 +13,29 @@
|
||||||
<strong>Tiny RDM is a modern lightweight cross-platform Redis desktop manager available for Mac, Windows, and Linux.</strong>
|
<strong>Tiny RDM is a modern lightweight cross-platform Redis desktop manager available for Mac, Windows, and Linux.</strong>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
![](screenshots/light_en.png)
|
![](screenshots/dark_en.png)
|
||||||
|
|
||||||
## Feature
|
## Feature
|
||||||
|
|
||||||
* Built on Webview, no embedded browsers (Thanks to [Wails](https://github.com/wailsapp/wails)).
|
* Super lightweight, built on Webview2, without 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)
|
* 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)).
|
and [IconPark](https://iconpark.oceanengine.com)).
|
||||||
* Multi-language support (Click here to contribute and support more languages).
|
* Multi-language support ([Need more languages ? Click here to contribute](.github/CONTRIBUTING.md)).
|
||||||
* Convenient data viewing and editing.
|
* Better connection management: supports SSH Tunnel/SSL/Sentinel Mode/Cluster Mode.
|
||||||
* More features under continuous development...
|
* 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
|
## Installation
|
||||||
|
|
||||||
We publish binaries for Mac, Windows, and Linux.
|
|
||||||
Available to download for free from [here](https://github.com/tiny-craft/tiny-rdm/releases).
|
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:
|
> 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
|
> sudo xattr -d com.apple.quarantine /Applications/Tiny\ RDM.app
|
||||||
> ```
|
> ```
|
||||||
|
|
||||||
## Build
|
## Build Guidelines
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
* Go >= 1.21
|
* Go (latest version)
|
||||||
* Node.js >= 16
|
* Node.js >= 16
|
||||||
* NPM >= 9
|
* NPM >= 9
|
||||||
|
|
||||||
|
|
|
@ -13,14 +13,14 @@
|
||||||
<strong>一个现代化轻量级的跨平台Redis桌面客户端,支持Mac、Windows和Linux</strong>
|
<strong>一个现代化轻量级的跨平台Redis桌面客户端,支持Mac、Windows和Linux</strong>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
![screenshot](screenshots/light_zh.png)
|
![screenshot](screenshots/dark_zh.png)
|
||||||
|
|
||||||
## 功能特性
|
## 功能特性
|
||||||
|
|
||||||
* 极度轻量,基于Webview2,无内嵌浏览器(感谢[Wails](https://github.com/wailsapp/wails))
|
* 极度轻量,基于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))
|
和 [IconPark](https://iconpark.oceanengine.com))
|
||||||
* 多国语言支持:英文/中文(点我贡献和完善多国语言支持)
|
* 多国语言支持:英文/中文([需要更多语言支持?点我贡献语言](.github/CONTRIBUTING_zh.md))
|
||||||
* 更好用的连接管理:支持SSH隧道/SSL/哨兵模式/集群模式
|
* 更好用的连接管理:支持SSH隧道/SSL/哨兵模式/集群模式
|
||||||
* 可视化键值操作,增删查改一应俱全
|
* 可视化键值操作,增删查改一应俱全
|
||||||
* 支持多种数据查看格式以及转码/解压方式
|
* 支持多种数据查看格式以及转码/解压方式
|
||||||
|
@ -29,6 +29,7 @@
|
||||||
|
|
||||||
## 未来版本规划
|
## 未来版本规划
|
||||||
- [ ] List/Hash/Set/Sorted Set的分页展示和查询
|
- [ ] List/Hash/Set/Sorted Set的分页展示和查询
|
||||||
|
- [ ] List/Hash/Set/Sorted Set值的转码显示
|
||||||
- [ ] 慢日志展示
|
- [ ] 慢日志展示
|
||||||
- [ ] 命令实时监控
|
- [ ] 命令实时监控
|
||||||
- [ ] 发布/订阅支持
|
- [ ] 发布/订阅支持
|
||||||
|
|
|
@ -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 `<script setup>` SFCs,
|
Use Vue3 + Vite
|
||||||
check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
|
||||||
|
|
||||||
## Recommended IDE Setup
|
|
||||||
|
|
||||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
|
||||||
|
|
Before Width: | Height: | Size: 311 KiB After Width: | Height: | Size: 320 KiB |
Before Width: | Height: | Size: 317 KiB After Width: | Height: | Size: 325 KiB |
Before Width: | Height: | Size: 311 KiB After Width: | Height: | Size: 329 KiB |
Before Width: | Height: | Size: 317 KiB After Width: | Height: | Size: 334 KiB |