From c1712afdf54ac60fc937c0c0e766adbb7b487fa9 Mon Sep 17 00:00:00 2001 From: hvsalesforce <73243807+hvsalesforce@users.noreply.github.com> Date: Wed, 21 Oct 2020 21:33:31 +0530 Subject: [PATCH 1/2] Rename README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 05538bb9b04791b895680d641cf3065d32046852 Mon Sep 17 00:00:00 2001 From: hvsalesforce <73243807+hvsalesforce@users.noreply.github.com> Date: Wed, 21 Oct 2020 21:46:07 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index be3534c..3e9126b 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,35 @@ -A very fast Redis client for the JVM. +# A very fast Redis client for the JVM. -Description of each module: +### Description of each module: -redisgen/ +* redisgen/ Scrapes the redis.io/commands page and produce various typed clients and servers, very extensible - -util/ + +* util/ Some common encoding and data structures -client/ - Leverages the protocol module for encoding and decoding. Supports both synchronous - and asynchronous pipelined requests from the RedisClient. Supports 2.6 commands. -protocol/ - Redis protocol encoder / decoder based on input/outputstreams. This is the - fastest implementation if blocking i/o is ok for your use case. -benchmark/ + +* client/ + Leverages the protocol module for encoding and decoding. Supports both synchronous and asynchronous pipelined requests from the RedisClient. Supports 2.6 commands. + +* protocol/ + Redis protocol encoder / decoder based on input/outputstreams. This is the fastest implementation if blocking i/o is ok for your use case. + +* benchmark/ A redis-benchmark clone that uses this Java client for comparison testing. - -netty/ + +* netty/ A netty 3.5.X compatible codecs for building Redis clients -netty-client/ + +* netty-client/ Complete client except for MULTI/EXEC. - -netty4/ + +* netty4/ A netty 4.0.0.Alpha1 compatible codec for building Redis clients -netty4-server/ + +* netty4-server/ A very high performance in-JVM memory redis server clone - -util/ + +* util/ Some library functions used by both the blocking client and the netty clients In the experiments branch you can find: @@ -68,7 +71,7 @@ Various redis client benchmarks - netty 4, custom codec - 5.08 MB/s - 19,601 sps - - redis-benchmark -n 1000000 -c 1 -r 1000000 set test test + - `redis-benchmark -n 1000000 -c 1 -r 1000000 set test test` - C client included with distribution - 5.53 MB/s - 22,055 sps @@ -94,9 +97,7 @@ Copyright 2012 Sam Pullara Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 + You may obtain a copy of the License [here](http://www.apache.org/licenses/LICENSE-2.0). Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,