add nested types to redis

README.md

@@ -1,6 +1,6 @@
 # redis
 
-is a Redis client library for Carp.
+A Redis client library for Carp, supporting Redis 7.x.
 
 ## Installation
 
@@ -10,11 +10,51 @@ is a Redis client library for Carp.
 
 ## Usage
 
-This package contains functions to convert to and from the Redis protocol,
-and handling Redis connections and commands. The documentation lives
-[here](https://veitheller.de/redis).
+```clojure
+(load "redis.carp")
 
-You can also look at the examples in the [`examples`](./examples) directory.
+(defn main []
+  (match (Redis.open "127.0.0.1")
+    (Result.Success r)
+      (do
+        (println* &(Redis.ping &r))
+        (println* &(Redis.set &r @"key" @"value"))
+        (println* &(Redis.get &r @"key"))
+
+        ; list operations return nested RESP arrays
+        (println* &(Redis.rpush &r @"mylist" @"a"))
+        (println* &(Redis.rpush &r @"mylist" @"b"))
+        (println* &(Redis.lrange &r @"mylist" @"0" @"-1"))
+
+        ; pattern match on responses
+        (match (Redis.get &r @"key")
+          (Result.Success resp)
+            (match resp
+              (RESP.Str s) (println* "got: " &s)
+              (RESP.Null) (println* "key not found")
+              _ (println* "unexpected type"))
+          (Result.Error e) (println* "error: " &e))
+
+        (Redis.close r))
+    (Result.Error err) (IO.errorln &err)))
+```
+
+The library provides thin wrappers around all standard Redis commands through
+7.2, so you can call them directly (e.g. `Redis.get`, `Redis.hset`,
+`Redis.lrange`). For commands with complex or variadic arguments, use
+`Redis.send` directly:
+
+```clojure
+(Redis.send &r @"SET" &[(to-redis @"key") (to-redis @"value")])
+(Redis.read &r)
+```
+
+The RESP type supports recursive arrays via `Box`, so nested structures
+(e.g. from `XRANGE` or `COMMAND`) are decoded faithfully.
+
+Full API documentation lives [here](https://veitheller.de/redis).
+
+More examples are in the [`examples`](./examples) directory.
 
 <hr/>