Update README (#377)

This commit is contained in:
Lunny Xiao 2020-04-24 13:01:35 +08:00 committed by GitHub
parent 9baea07f40
commit 04ab07acd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 17 deletions

View File

@ -1,6 +1,6 @@
# LedisDB # LedisDB
[![Build Status](https://travis-ci.org/siddontang/ledisdb.svg?branch=develop)](https://travis-ci.org/siddontang/ledisdb) [![Build Status](https://travis-ci.org/ledisdb/ledisdb.svg?branch=develop)](https://travis-ci.org/ledisdb/ledisdb)
Ledisdb is a high-performance NoSQL database, similar to Redis, written in [Go](http://golang.org/). It supports many data structures including kv, list, hash, zset, set. Ledisdb is a high-performance NoSQL database, similar to Redis, written in [Go](http://golang.org/). It supports many data structures including kv, list, hash, zset, set.
@ -8,7 +8,6 @@ LedisDB now supports multiple different databases as backends.
### **You must run `ledis-upgrade-ttl` before using LedisDB version 0.4, I fixed a very serious bug for key expiration and TTL.** ### **You must run `ledis-upgrade-ttl` before using LedisDB version 0.4, I fixed a very serious bug for key expiration and TTL.**
## Features ## Features
+ Rich data structure: KV, List, Hash, ZSet, Set. + Rich data structure: KV, List, Hash, ZSet, Set.
@ -24,15 +23,12 @@ LedisDB now supports multiple different databases as backends.
+ Supports cluster, use [xcodis](https://github.com/siddontang/xcodis) + Supports cluster, use [xcodis](https://github.com/siddontang/xcodis)
+ Authentication (though, not via http) + Authentication (though, not via http)
## Build and Install ## Build from source
Create a workspace and checkout ledisdb source Create a workspace and checkout ledisdb source
mkdir $WORKSPACE git clone git@github.com:ledisdb/ledisdb.git
cd $WORKSPACE cd ledisdb
git clone git@github.com:siddontang/ledisdb.git src/github.com/siddontang/ledisdb
cd src/github.com/siddontang/ledisdb
#set build and run environment #set build and run environment
source dev.sh source dev.sh
@ -40,6 +36,8 @@ Create a workspace and checkout ledisdb source
make make
make test make test
Then you will find all the binary build on `./bin` directory.
## LevelDB support ## LevelDB support
+ Install leveldb and snappy. + Install leveldb and snappy.
@ -50,7 +48,7 @@ Create a workspace and checkout ledisdb source
It will install leveldb at /usr/local/leveldb and snappy at /usr/local/snappy by default. It will install leveldb at /usr/local/leveldb and snappy at /usr/local/snappy by default.
LedisDB uses the modified LevelDB for better performance. [Details.](https://github.com/siddontang/ledisdb/wiki/leveldb-source-modification) LedisDB uses the modified LevelDB for better performance. [Details.](https://github.com/ledisdb/ledisdb/wiki/leveldb-source-modification)
You can easily use other LevelDB versions (like Hyper LevelDB or Basho LevelDB) instead, as long as the header files are in `include/leveldb`, not `include/hyperleveldb` or any other location. You can easily use other LevelDB versions (like Hyper LevelDB or Basho LevelDB) instead, as long as the header files are in `include/leveldb`, not `include/hyperleveldb` or any other location.
@ -122,8 +120,8 @@ If you don't use a configuration, LedisDB will use the default for you.
## Package Example ## Package Example
import ( import (
lediscfg "github.com/siddontang/ledisdb/config" lediscfg "github.com/ledisdb/ledisdb/config"
"github.com/siddontang/ledisdb/ledis" "github.com/ledisdb/ledisdb/ledis"
) )
# Use Ledis's default config # Use Ledis's default config
@ -151,21 +149,21 @@ LedisDB uses a proxy named [xcodis](https://github.com/siddontang/xcodis) to sup
## Benchmark ## Benchmark
See [benchmark](https://github.com/siddontang/ledisdb/wiki/Benchmark) for more. See [benchmark](https://github.com/ledisdb/ledisdb/wiki/Benchmark) for more.
## Todo ## Todo
See [Issues todo](https://github.com/siddontang/ledisdb/issues?labels=todo&page=1&state=open) See [Issues todo](https://github.com/ledisdb/ledisdb/issues?labels=todo&page=1&state=open)
## Client ## Client
See [Clients](https://github.com/siddontang/ledisdb/wiki/Clients) to find or contribute LedisDB client. See [Clients](https://github.com/ledisdb/ledisdb/wiki/Clients) to find or contribute LedisDB client.
## Links ## Links
+ [Official Website](http://ledisdb.com) + [Official Website](https://ledisdb.io)
+ [GoDoc](https://godoc.org/github.com/siddontang/ledisdb) + [GoDoc](https://godoc.org/github.com/ledisdb/ledisdb)
+ [Server Commands](https://github.com/siddontang/ledisdb/wiki/Commands) + [Server Commands](https://github.com/ledisdb/ledisdb/wiki/Commands)
## Caveat ## Caveat