summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-03 12:00:17 +0100
committerPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-03 12:00:17 +0100
commitf023f9cfd51bb8f004362b8efabdbdf8e4f83a1f (patch)
treecd2be87fadd6d710db4f6a527c5737be4d891c01 /README.md
parent3be1d6e66d23ebc92a224b4d85b69ca6b110acdc (diff)
Upgrade notice in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index beca586..1526642 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,13 @@ Redis version >= 1.2.0.
The library comes with multiple APIs. There is the
*synchronous API*, the *asynchronous API* and the *reply parsing API*.
+## UPGRADING
+
+Version 0.9.0 is a major overhaul of hiredis in every aspect. However, upgrading existing
+code using hiredis should not be a big pain. The key thing to keep in mind when
+upgrading is that hiredis >= 0.9.0 uses a `redisContext*` to keep state, in contrast to
+the stateless 0.0.1 that only has a file descriptor to work with.
+
## SYNCHRONOUS API
To consume the synchronous API, there are only a few function calls that need to be introduced: