github.com/flower-corp/rosedb@v1.1.2-0.20230117132829-21dc4f7b319a/README.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  # The project is being refactored and should not be used in a production, thanks for your support!
     6  # 项目正在重构中，暂时不要用于生产环境，谢谢支持！
     7  English| [简体中文](https://github.com/roseduan/rosedb/blob/main/README-CN.md)
     8  
     9  rosedb is a fast, stable, and embedded NoSQL database based on `bitcask`, supports a variety of data structures such as `string`, `list`, `hash`, `set`, and `sorted set`.     
    10  
    11  It is similar to `Redis` but store values on disk.
    12  
    13  Key features:
    14  
    15  * **Compatible with Redis protocol (not fully)**
    16  * **Many data structures: `string`, `list`, `hash`, `set`, and `sorted set`**
    17  * **Easy to embed into your own Go application**
    18  * **High performance, suitable for both read and write intensive workload**
    19  * **Values are not limited by RAM**
    20  
    21  ## Design Overview
    22  
    23  ![](https://github.com/flower-corp/rosedb/blob/main/resource/img/design-overview-rosedb.png)
    24  
    25  ## Quick Start
    26  
    27  **1. embedded usage:** see [examples](https://github.com/flower-corp/rosedb/tree/main/examples)
    28  
    29  **2. command line usage:**
    30  
    31  start rosedb server
    32  
    33  ```shell
    34  cd rosedb
    35  make
    36  ./rosedb-server [-option value]
    37  ```
    38  
    39  access data via `cli`(a copy of `redis-cli`)
    40  
    41  > Only mac now, download redis-cli according to your os.
    42  
    43  ```shell
    44  cd rosedb/tools
    45  ./cli-mac -p 5200
    46  
    47  127.0.0.1:5200> 
    48  127.0.0.1:5200> set my_key RoseDB
    49  OK
    50  127.0.0.1:5200> get my_key
    51  "RoseDB"
    52  127.0.0.1:5200> 
    53  
    54  ```
    55  
    56  ## Documentation
    57  
    58  See [wiki](https://github.com/flower-corp/rosedb/wiki)
    59  
    60  ## Community
    61  
    62  Welcome to join the [Slack channel](https://join.slack.com/t/flowercorp-slack/shared_invite/zt-19oj8ecqb-V02ycMV0BH1~Tn6tfeTz6A) and [Discussions](https://github.com/flower-corp/rosedb/discussions) to connect with RoseDB team members and other users.
    63  
    64  If you are a Chinese user, you are also welcome to join our WeChat group, scan the QR code and you will be invited:
    65  
    66  | <img src="https://i.loli.net/2021/05/06/tGTH7SXg8w95slA.jpg" width="200px" align="left"/> |
    67  | ------------------------------------------------------------ |
    68  
    69  ## Contributing
    70  
    71  If you are interested in contributing to rosedb, see [CONTRIBUTING](https://github.com/roseduan/rosedb/blob/main/CONTRIBUTING.md) and [how to contribute?](https://github.com/flower-corp/rosedb/issues/103)
    72  
    73  ## License
    74  
    75  rosedb is licensed under the term of the [Apache 2.0 License](https://github.com/roseduan/rosedb/blob/main/LICENSE)
    76