github.com/flower-corp/rosedb@v1.1.2-0.20230117132829-21dc4f7b319a/README-CN.md (about)

     1  ![rosedb_ico.png](https://i.loli.net/2021/04/28/gIL2FXZcOesPmyD.png)
     2  
     3  [![Go Report Card](https://goreportcard.com/badge/github.com/roseduan/rosedb) ](https://goreportcard.com/report/github.com/roseduan/rosedb)![GitHub top language](https://img.shields.io/github/languages/top/roseduan/rosedb) [![GitHub stars](https://img.shields.io/github/stars/roseduan/rosedb) ](https://github.com/roseduan/rosedb/stargazers)[![codecov](https://codecov.io/gh/flower-corp/rosedb/branch/main/graph/badge.svg)](https://codecov.io/gh/flower-corp/rosedb) [![CodeFactor](https://www.codefactor.io/repository/github/flower-corp/rosedb/badge)](https://www.codefactor.io/repository/github/flower-corp/rosedb) [![Go Reference](https://pkg.go.dev/badge/github.com/roseduan/rosedb.svg)](https://pkg.go.dev/github.com/roseduan/rosedb) [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go#database) [![LICENSE](https://img.shields.io/github/license/flower-corp/rosedb.svg?style=flat-square)](https://github.com/flower-corp/rosedb/blob/main/LICENSE)
     4  
     5  [English](https://github.com/roseduan/rosedb#rosedb) | 简体中文
     6  
     7  rosedb 是一个稳定、快速、内嵌的 NoSQL 数据库，支持多种数据结构，包含 `String`、`List`、`Hash`、`Set`、`Sorted Set`。
     8  
     9  rosedb 类似于 `Redis`，但是可以选择将 value 存储到磁盘中。
    10  
    11  主要特性：
    12  
    13  * **兼容 Redis 协议**
    14  * **支持丰富的数据结构，包含 `String`、`List`、`Hash`、`Set`、`Sorted Set`**
    15  * **内嵌使用，维护成本低**
    16  * **高性能，对读写负载的应用都适合**
    17  * **数据不局限于内存容量**
    18  
    19  ## 架构设计
    20  
    21  ![](https://github.com/flower-corp/rosedb/blob/main/resource/img/design-overview-rosedb.png)
    22  
    23  ## 快速开始
    24  
    25  **1. 内嵌使用，请参考：**[examples](https://github.com/flower-corp/rosedb/tree/main/examples)
    26  
    27  **2. 做为 Server 使用**
    28  
    29  启动 rosedb server：
    30  
    31  ```shell
    32  cd rosedb
    33  make
    34  ./rosedb-server [-option value]
    35  ```
    36  
    37  通过 cli 工具访问数据(这里的 cli 工具实际上就是 `redis-cli`)
    38  
    39  > 目前 cli 工具只有 mac 系统的，可根据你的系统下载对应的 redis-cli 工具
    40  
    41  ```shell
    42  cd rosedb/tools
    43  ./cli-mac -p 5200
    44  
    45  127.0.0.1:5200> 
    46  127.0.0.1:5200> set my_key RoseDB
    47  OK
    48  127.0.0.1:5200> get my_key
    49  "RoseDB"
    50  127.0.0.1:5200> 
    51  
    52  ```
    53  
    54  ## 文档
    55  
    56  请参考 [wiki](https://github.com/flower-corp/rosedb/wiki)
    57  
    58  ## 参与贡献
    59  
    60  感谢你的参与，完整的步骤及规范，请参考：[CONTRIBUTING](https://github.com/roseduan/rosedb/blob/main/CONTRIBUTING.md)
    61  
    62  新手参与贡献，请参考：https://github.com/flower-corp/rosedb/issues/97
    63  
    64  ## 交流群
    65  
    66  欢迎加我微信，拉你进 rosedb 项目交流群，和大牛一起交流学习。
    67  
    68  | <img src="https://i.loli.net/2021/05/06/tGTH7SXg8w95slA.jpg" width="200px" align="left"/> |
    69  | ------------------------------------------------------------ |
    70  | 添加时请备注【Github】哦                                     |
    71  
    72  ## License
    73  
    74  rosedb 根据 Apache 2.0 License 许可证授权，有关完整许可证文本，请参阅 [LICENSE](https://github.com/roseduan/rosedb/blob/main/LICENSE)。
    75