Document single connection use.

pascaldekloe · Sep 10, 2019 · 2d379ff · 2d379ff
1 parent dd58ec8
commit 2d379ff
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@
 
 … a redis client for the Go programming language.
 
+The implementation utilises a single network connection with asynchronous I/O.
+Connection multiplexing causes overhead and higher latencies for all commands.
+
 This is free and unencumbered software released into the
 [public domain](https://creativecommons.org/publicdomain/zero/1.0).
 

diff --git a/redis.go b/redis.go
@@ -1,5 +1,7 @@
-// Package redis provides Redis service access. All communication is fully
-// asynchronous. See https://redis.io/topics/pipelining for details.
+// Package redis provides Redis service access. The implementation utilises a
+// single network connection. Redis supports asynchronous I/O to optimize
+// concurrent workflows. See <https://redis.io/topics/pipelining> for details.
+// Use a separate Client when executing commands that may block, like FLUSHDB.
 package redis
 
 import (