Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Congyuwang authored Jun 13, 2023
1 parent f8e9206 commit 3431c98
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# RocksDict
# RocksDict / SpeeDict

**Key-value storage supporting any python object**
**Key-value storage for Python & Wrapper of Rocksdb and Speedb**

![CI](https://github.com/Congyuwang/RocksDict/actions/workflows/CI.yml/badge.svg)
![PyPI](https://img.shields.io/pypi/dm/rocksdict)
![PyPI](https://img.shields.io/pypi/wheel/rocksdict)
[![Support python versions](https://img.shields.io/pypi/pyversions/rocksdict.svg)](https://pypi.org/project/rocksdict/)

## Installation

Wheels available, just
- `pip install rocksdict` for rocksdb backend, then `from rocksdict import Rdict`
- `pip install speedict` for speedb backend, then `from speedict import Rdict`

## Introduction

This library has two purposes.

1. As an on-disk key-value storage solution for Python.
2. As a RocksDB interface.
2. As a RocksDB / Speedict interface.

These two purposes operate in different modes:

Expand All @@ -22,10 +28,6 @@ These two purposes operate in different modes:
- **Raw mode** (`options=Options(raw_mode=True)`),
which allows storing only `bytes`.

## Installation

Wheels available, just `pip install rocksdict`.

## Examples

### A minimal example
Expand Down

0 comments on commit 3431c98

Please sign in to comment.