From 0b69b5017d6d9e8f21d5c5a6cdcb3036124beadb Mon Sep 17 00:00:00 2001 From: holys Date: Tue, 12 Aug 2014 14:44:16 +0800 Subject: [PATCH] update readme, add hyperleveldb --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9dc0ddb..36f89d7 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,16 @@ Ledisdb is a high performance NoSQL like Redis written by go. It supports some advanced data structure like kv, list, hash, zset, bitmap, and may be alternative for Redis. -LedisDB now supports multi databases as backend to store data, you can test and choose the proper one for you. +LedisDB now supports multiple databases as backend to store data, you can test and choose the proper one for you. ## Features + Rich advanced data structure: KV, List, Hash, ZSet, Bitmap. + Stores lots of data, over the memory limit. -+ Various backend database to use: LevelDB, goleveldb, LMDB, RocksDB, BoltDB. ++ Various backend database to use: LevelDB, goleveldb, LMDB, RocksDB, BoltDB, HyperLevelDB. + Supports expiration and ttl. + Redis clients, like redis-cli, are supported directly. -+ Multi client API supports, including Go, Python, Lua(Openresty). ++ Multiple client API supports, including Go, Python, Lua(Openresty), Node.js. + Easy to embed in your own Go application. + Restful API support, json/bson/msgpack output. + Replication to guarantee data safe. @@ -51,16 +51,29 @@ Create a workspace and checkout ledisdb source ## RocksDB support -+ Install rocksdb(shared_lib) and snappy first. ++ [Install rocksdb](https://github.com/facebook/rocksdb/blob/master/INSTALL.md)(`make shared_lib`) and snappy first. LedisDB has not supplied a simple script to install, maybe later. -+ Set ```ROCKSDB_DIR``` and ```SNAPPY_DIR``` to the actual install path in dev.sh. ++ Set ```ROCKSDB_DIR``` and ```SNAPPY_DIR``` to the actual install path in `dev.sh`. + ```make``` + + + +## HyperLevelDB support + ++ [Install hyperleveldb](https://github.com/rescrv/HyperLevelDB/blob/master/README) and snappy first. + + LedisDB has not supplied a simple script to install, maybe later. + ++ Set `HYPERLEVELDB` and `SNAPPY_DIR` to the actual install path in `dev.sh`. ++ `make` + + ## Choose store database -LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, it will choose goleveldb as default to store data if you not set. +LedisDB now supports goleveldb, lmdb, leveldb, rocksdb, boltdb, hyperleveldb. it will choose goleveldb as default to store data if you not set. Choosing a store database to use is very simple, you have two ways: