Skip to content

Commit f597f21

Browse files
authored
Merge pull request #904 from bpo/doc-patch
Minor documentation patches
2 parents 91b0a3f + c4efb2d commit f597f21

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
A Ruby client that tries to match [Redis][redis-home]' API one-to-one, while still
44
providing an idiomatic interface.
55

6+
See [RubyDoc.info][rubydoc] for the API docs of the latest published gem.
67

78
## Getting started
89

@@ -34,6 +35,9 @@ You can also specify connection options as a [`redis://` URL][redis-url]:
3435
redis = Redis.new(url: "redis://:[email protected]:6380/15")
3536
```
3637

38+
The client expects passwords with special chracters to be URL-encoded (i.e.
39+
`CGI.escape(password)`).
40+
3741
By default, the client will try to read the `REDIS_URL` environment variable
3842
and use that as URL to connect to. The above statement is therefore equivalent
3943
to setting this environment variable and calling `Redis.new` without arguments.
@@ -147,8 +151,8 @@ redis.mget('{key}1', '{key}2')
147151

148152
## Storing objects
149153

150-
Redis only stores strings as values. If you want to store an object, you
151-
can use a serialization mechanism such as JSON:
154+
Redis "string" types can be used to store serialized Ruby objects, for
155+
example with JSON:
152156

153157
```ruby
154158
require "json"
@@ -322,7 +326,7 @@ This library supports natively terminating client side SSL/TLS connections
322326
when talking to Redis via a server-side proxy such as [stunnel], [hitch],
323327
or [ghostunnel].
324328

325-
To enable SSL support, pass the `:ssl => :true` option when configuring the
329+
To enable SSL support, pass the `:ssl => true` option when configuring the
326330
Redis client, or pass in `:url => "rediss://..."` (like HTTPS for Redis).
327331
You will also need to pass in an `:ssl_params => { ... }` hash used to
328332
configure the `OpenSSL::SSL::SSLContext` object used for the connection:

0 commit comments

Comments
 (0)