From 04ab07acd4edbcb2e4ab90e5d403c11a411ff8f8 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 24 Apr 2020 13:01:35 +0800 Subject: [PATCH] Update README (#377) --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c8270f7..6c08de7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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. @@ -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.** - ## Features + 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) + Authentication (though, not via http) -## Build and Install +## Build from source Create a workspace and checkout ledisdb source - mkdir $WORKSPACE - cd $WORKSPACE - git clone git@github.com:siddontang/ledisdb.git src/github.com/siddontang/ledisdb - - cd src/github.com/siddontang/ledisdb + git clone git@github.com:ledisdb/ledisdb.git + cd ledisdb #set build and run environment source dev.sh @@ -40,6 +36,8 @@ Create a workspace and checkout ledisdb source make make test +Then you will find all the binary build on `./bin` directory. + ## LevelDB support + 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. - 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. @@ -122,8 +120,8 @@ If you don't use a configuration, LedisDB will use the default for you. ## Package Example import ( - lediscfg "github.com/siddontang/ledisdb/config" - "github.com/siddontang/ledisdb/ledis" + lediscfg "github.com/ledisdb/ledisdb/config" + "github.com/ledisdb/ledisdb/ledis" ) # Use Ledis's default config @@ -151,21 +149,21 @@ LedisDB uses a proxy named [xcodis](https://github.com/siddontang/xcodis) to sup ## Benchmark -See [benchmark](https://github.com/siddontang/ledisdb/wiki/Benchmark) for more. +See [benchmark](https://github.com/ledisdb/ledisdb/wiki/Benchmark) for more. ## 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 -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 -+ [Official Website](http://ledisdb.com) -+ [GoDoc](https://godoc.org/github.com/siddontang/ledisdb) -+ [Server Commands](https://github.com/siddontang/ledisdb/wiki/Commands) ++ [Official Website](https://ledisdb.io) ++ [GoDoc](https://godoc.org/github.com/ledisdb/ledisdb) ++ [Server Commands](https://github.com/ledisdb/ledisdb/wiki/Commands) ## Caveat