Skip to content

Commit 6f3380b

Browse files
fix: ensure the repo links in the README are functional on the website (#3005)
1 parent 742d571 commit 6f3380b

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ npm install redis
4545

4646
| Name | Description |
4747
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
48-
| [`redis`](./packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
49-
| [`@redis/client`](./packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
50-
| [`@redis/bloom`](./packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
51-
| [`@redis/json`](./packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
52-
| [`@redis/search`](./packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
53-
| [`@redis/time-series`](./packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
54-
| [`@redis/entraid`](./packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
48+
| [`redis`](https://github.com/redis/node-redis/tree/master/packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
49+
| [`@redis/client`](https://github.com/redis/node-redis/tree/master/packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
50+
| [`@redis/bloom`](https://github.com/redis/node-redis/tree/master/packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
51+
| [`@redis/json`](https://github.com/redis/node-redis/tree/master/packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
52+
| [`@redis/search`](https://github.com/redis/node-redis/tree/master/packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
53+
| [`@redis/time-series`](https://github.com/redis/node-redis/tree/master/packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
54+
| [`@redis/entraid`](https://github.com/redis/node-redis/tree/master/packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
5555

5656
> Looking for a high-level library to handle object mapping?
5757
> See [redis-om-node](https://github.com/redis/redis-om-node)!
@@ -83,7 +83,7 @@ createClient({
8383
```
8484

8585
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in
86-
the [client configuration guide](./docs/client-configuration.md).
86+
the [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
8787

8888
To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean.
8989
`client.isOpen` is also available. This returns `true` when the client's underlying socket is open, and `false` when it
@@ -188,7 +188,7 @@ await pool.ping();
188188

189189
### Pub/Sub
190190

191-
See the [Pub/Sub overview](./docs/pub-sub.md).
191+
See the [Pub/Sub overview](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md).
192192

193193
### Scan Iterator
194194

@@ -234,7 +234,6 @@ of sending a `QUIT` command to the server, the client can simply close the netwo
234234
```typescript
235235
client.destroy();
236236
```
237-
238237
### Client Side Caching
239238

240239
Node Redis v5 adds support for [Client Side Caching](https://redis.io/docs/manual/client-side-caching/), which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.
@@ -251,7 +250,7 @@ const client = createClient({
251250
});
252251
```
253252

254-
See the [V5 documentation](./docs/v5.md#client-side-caching) for more details and advanced usage.
253+
See the [V5 documentation](https://github.com/redis/node-redis/blob/master/docs/v5.md#client-side-caching) for more details and advanced usage.
255254

256255
### Auto-Pipelining
257256

@@ -275,11 +274,11 @@ await Promise.all([
275274

276275
### Programmability
277276

278-
See the [Programmability overview](./docs/programmability.md).
277+
See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
279278

280279
### Clustering
281280

282-
Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
281+
Check out the [Clustering Guide](https://github.com/redis/node-redis/blob/master/docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
283282

284283
### Events
285284

@@ -292,12 +291,12 @@ The Node Redis client class is an Nodejs EventEmitter and it emits an event each
292291
| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
293292
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
294293
| `reconnecting` | Client is trying to reconnect to the server | _No arguments_ |
295-
| `sharded-channel-moved` | See [here](./docs/pub-sub.md#sharded-channel-moved-event) | See [here](./docs/pub-sub.md#sharded-channel-moved-event) |
294+
| `sharded-channel-moved` | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) |
296295

297296
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
298297
> an `error` occurs, that error will be thrown and the Node.js process will exit. See the [ > `EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.
299298
300-
> The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
299+
> The client will not emit [any other events](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
301300
302301
## Supported Redis versions
303302

@@ -314,18 +313,18 @@ Node Redis is supported with the following versions of Redis:
314313
315314
## Migration
316315

317-
- [From V3 to V4](docs/v3-to-v4.md)
318-
- [From V4 to V5](docs/v4-to-v5.md)
319-
- [V5](docs/v5.md)
316+
- [From V3 to V4](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md)
317+
- [From V4 to V5](https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md)
318+
- [V5](https://github.com/redis/node-redis/blob/master/docs/v5.md)
320319

321320
## Contributing
322321

323-
If you'd like to contribute, check out the [contributing guide](CONTRIBUTING.md).
322+
If you'd like to contribute, check out the [contributing guide](https://github.com/redis/node-redis/blob/master/CONTRIBUTING.md).
324323

325324
Thank you to all the people who already contributed to Node Redis!
326325

327326
[![Contributors](https://contrib.rocks/image?repo=redis/node-redis)](https://github.com/redis/node-redis/graphs/contributors)
328327

329328
## License
330329

331-
This repository is licensed under the "MIT" license. See [LICENSE](LICENSE).
330+
This repository is licensed under the "MIT" license. See [LICENSE](https://github.com/redis/node-redis/blob/master/LICENSE).

0 commit comments

Comments
 (0)