Skip to content

Commit 4e52981

Browse files
author
Ruben Bridgewater
committed
Small Readme fixes
1 parent dfb1d93 commit 4e52981

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ Install with:
1212

1313
npm install redis
1414

15-
## Usage
16-
17-
Simple example, included as `examples/simple.js`:
15+
## Usage Example
1816

1917
```js
2018
var redis = require("redis"),
@@ -83,7 +81,7 @@ return client.multi().get('foo').execAsync().then(function(res) {
8381
Each Redis command is exposed as a function on the `client` object.
8482
All functions take either an `args` Array plus optional `callback` Function or
8583
a variable number of individual arguments followed by an optional callback.
86-
Here are examples how to use the api:
84+
Examples:
8785

8886
```js
8987
client.hmset(["key", "test keys 1", "test val 1", "test keys 2", "test val 2"], function (err, res) {});
@@ -182,7 +180,7 @@ __Tip:__ If the Redis server runs on the same machine as the client consider usi
182180
| host | 127.0.0.1 | IP address of the Redis server |
183181
| port | 6379 | Port of the Redis server |
184182
| path | null | The UNIX socket string of the Redis server |
185-
| url | null | The URL of the Redis server. Format: `[redis:]//[user][:password@][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]` (More info avaliable at [IANA](http://www.iana.org/assignments/uri-schemes/prov/redis)). |
183+
| url | null | The URL of the Redis server. Format: `[redis:]//[[user][:password@]][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]` (More info avaliable at [IANA](http://www.iana.org/assignments/uri-schemes/prov/redis)). |
186184
| parser | hiredis | If hiredis is not installed, automatic fallback to the built-in javascript parser |
187185
| string_numbers | null | Set to `true`, `node_redis` will return Redis number values as Strings instead of javascript Numbers. Useful if you need to handle big numbers (above `Number.MAX_SAFE_INTEGER === 2^53`). Hiredis is incapable of this behavior, so setting this option to `true` will result in the built-in javascript parser being used no matter the value of the `parser` option. |
188186
| return_buffers | false | If set to `true`, then all replies will be sent to callbacks as Buffers instead of Strings. |
@@ -363,7 +361,7 @@ client.HMSET(key1, "0123456789", "abcdefghij", "some manner of key", "a type of
363361

364362
## Publish / Subscribe
365363

366-
Here is a simple example of the API for publish / subscribe. This program opens two
364+
Example of the publish / subscribe API. This program opens two
367365
client connections, subscribes to a channel on one of them, and publishes to that
368366
channel on the other:
369367

@@ -539,7 +537,7 @@ across all client connections, including from other client libraries and other c
539537
A `monitor` event is going to be emitted for every command fired from any client connected to the server including the monitoring client itself.
540538
The callback for the `monitor` event takes a timestamp from the Redis server, an array of command arguments and the raw monitoring string.
541539

542-
Here is a simple example:
540+
Example:
543541

544542
```js
545543
var client = require("redis").createClient();

0 commit comments

Comments
 (0)