Skip to content

Commit

Permalink
docs: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tiny-craft committed Dec 29, 2023
1 parent 4dc8839 commit d2bb299
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 51 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<h4 align="right"><strong>English</strong> | <a href="https://github.com/tiny-craft/tiny-rdm/blob/main/README_zh.md">简体中文</a></h4>
<h4 align="right"><strong>English</strong> | <a href="https://github.com/tiny-craft/tiny-rdm/blob/main/README_zh.md">
简体中文</a></h4>
<div align="center">
<a href="https://github.com/tiny-craft/tiny-rdm/"><img src="build/appicon.png" width="120"/></a>
</div>
Expand All @@ -12,7 +13,8 @@
[![Discord](https://img.shields.io/discord/1170373259133456434?label=Discord&color=5865F2)](https://discord.gg/VTFbBMGjWh)
[![X](https://img.shields.io/badge/Twitter-black?logo=x&logoColor=white)](https://twitter.com/Lykin53448)

<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>

<picture>
Expand All @@ -23,7 +25,8 @@

## Feature

* Super lightweight, built on Webview2, without 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, 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 ([Need more languages ? Click here to contribute](.github/CONTRIBUTING.md)).
Expand All @@ -37,12 +40,13 @@
* Segmented loading and querying for List/Hash/Set/Sorted Set.
* Decode/decompression display for value of List/Hash/Set/Sorted Set.
* Inbuilt advanced editor - Monaco Editor.
* Real-time commands monitoring.
* Support import/export data.

## Roadmap
- [ ] Real-time commands monitoring

- [ ] Pub/Sub operations
- [ ] Import/export connection profile
- [ ] Import/export data

## Installation

Expand All @@ -54,27 +58,33 @@ Available to download for free from [here](https://github.com/tiny-craft/tiny-rd
> ```
## Build Guidelines
### Prerequisites
* Go (latest version)
* Node.js >= 16
* NPM >= 9
### Install wails
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
```
### Clone the code

```bash
git clone https://github.com/tiny-craft/tiny-rdm --depth=1
```

### Build frontend

```bash
npm install --prefix ./frontend
```

### Compile and run

```bash
wails dev
```
Expand Down
13 changes: 11 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,13 @@
* List/Hash/Set/Sorted Set的分段加载和查询
* List/Hash/Set/Sorted Set值的转码显示
* 内置高级编辑器Monaco Editor
* 支持命令实时监控
* 支持数据导入/导出

## 未来版本规划
- [ ] 命令实时监控

- [ ] 发布/订阅支持
- [ ] 连接配置导入/导出
- [ ] 数据导入/导出

## 安装

Expand All @@ -54,34 +55,42 @@
> ```
## 构建项目
### 运行环境要求
* Go(最新版本)
* Node.js >= 16
* NPM >= 9
### 安装wails
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
```
### 拉取代码

```bash
git clone https://github.com/tiny-craft/tiny-rdm --depth=1
```

### 构建前端代码

```bash
npm install --prefix ./frontend
```

### 编译运行开发版本

```bash
wails dev
```

## 关于

此APP由我个人开发,也作为本人第一个开源项目的尝试,由于精力有限,可能会存在BUG或者使用体验上的问题,欢迎提交issue和PR。
同时本人也在探索开源代码、独立开发和盈利性商业应用之间的平衡关系,欢迎有共同意向的小伙伴加入群聊探讨和交换想法。

* QQ群:831077639

## 开源许可
Expand Down
Loading

0 comments on commit d2bb299

Please sign in to comment.