diff --git a/.github/README.md b/.github/README.md index b5894f6f70..6bc4458828 100644 --- a/.github/README.md +++ b/.github/README.md @@ -9,12 +9,6 @@ Coverage - - Downloads - - - Version - Chat @@ -28,7 +22,7 @@ npm install redis@next ``` -> :warning: The new interface is clean and cool, but if you have an existing code base, you'll want to read the [migration guide](./docs/v3-to-v4.md). +> :warning: The new interface is clean and cool, but if you have an existing code base, you'll want to read the [migration guide](../docs/v3-to-v4.md). ## Usage @@ -57,7 +51,7 @@ createClient({ }); ``` -You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](./docs/client-configuration.md). +You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](../docs/client-configuration.md). ### Redis Commands @@ -115,7 +109,7 @@ const [setKeyReply, otherKeyValue] = await client You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling `.watch()`. Your transaction will abort if any of the watched keys change. -To dig deeper into transactions, check out the [Isolated Execution Guide](./docs/isolated-execution.md). +To dig deeper into transactions, check out the [Isolated Execution Guide](../docs/isolated-execution.md). ### Blocking Commands @@ -133,7 +127,7 @@ await client.lPush('key', ['1', '2']); await blPopPromise; // '2' ``` -To learn more about isolated execution, check out the [guide](./docs/isolated-execution.md). +To learn more about isolated execution, check out the [guide](../docs/isolated-execution.md). ### Pub/Sub @@ -278,7 +272,7 @@ await Promise.all([ ### Clustering -Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster. +Check out the [Clustering Guide](../docs/clustering.md) when using Node Redis to connect to a Redis Cluster. ## Supported Redis versions @@ -295,12 +289,12 @@ Node Redis is supported with the following versions of Redis: ## Packages -| Name | Description | -|------------------------------------|------------------------------------------------------------| -| [redis](./packages/all-in-one) | | -| [@redis/client](./packages/client) | | -| [@redis/json](./packages/json) | [Redis JSON](https://oss.redis.com/redisjson/) commands | -| [@redis/search](./packages/search) | [Redis Search](https://oss.redis.com/redisearch/) commands | +| Name | Description | +|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [redis](../) | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis/v/next) [![Version](https://img.shields.io/npm/v/redis/next.svg)](https://www.npmjs.com/package/redis/v/next) | +| [@redis/client](../packages/client) | [![Downloads](https://img.shields.io/npm/dm/@redis/client.svg)](https://www.npmjs.com/package/@redis/client/v/next) [![Version](https://img.shields.io/npm/v/@redis/client/next.svg)](https://www.npmjs.com/package/@redis/client/v/next) | +| [@redis/json](../packages/json) | [![Downloads](https://img.shields.io/npm/dm/@redis/json.svg)](https://www.npmjs.com/package/@redis/json/v/next) [![Version](https://img.shields.io/npm/v/@redis/json/next.svg)](https://www.npmjs.com/package/@redis/json/v/next) [Redis JSON](https://oss.redis.com/redisjson/) commands | +| [@redis/search](../packages/search) | [![Downloads](https://img.shields.io/npm/dm/@redis/search.svg)](https://www.npmjs.com/package/@redis/search/v/next) [![Version](https://img.shields.io/npm/v/@redis/search/next.svg)](https://www.npmjs.com/package/@redis/search/v/next) [Redis Search](https://oss.redis.com/redisearch/) commands | ## Contributing diff --git a/.release-it.json b/.release-it.json new file mode 100644 index 0000000000..984af58564 --- /dev/null +++ b/.release-it.json @@ -0,0 +1,5 @@ +{ + "git": { + "tagName": "redis@${version}" + } +} \ No newline at end of file diff --git a/docs/client-configuration.md b/docs/client-configuration.md index 3b6b7dcad7..1dbbdd8cba 100644 --- a/docs/client-configuration.md +++ b/docs/client-configuration.md @@ -15,7 +15,7 @@ | username | | ACL username ([see ACL guide](https://redis.io/topics/acl)) | | password | | ACL password or the old "--requirepass" password | | database | | Database number to connect to (see [`SELECT`](https://redis.io/commands/select) command) | -| modules | | Object defining which [Redis Modules](../../README.md#modules) to include | +| modules | | Object defining which [Redis Modules](../.github/README.md#packages) to include | | scripts | | Object defining Lua Scripts to use with this client (see [Lua Scripts](../README.md#lua-scripts)) | | commandsQueueMaxLength | | Maximum length of the client's internal command queue | | readonly | `false` | Connect in [`READONLY`](https://redis.io/commands/readonly) mode | diff --git a/packages/client/.release-it.json b/packages/client/.release-it.json new file mode 100644 index 0000000000..d8e2b65186 --- /dev/null +++ b/packages/client/.release-it.json @@ -0,0 +1,5 @@ +{ + "git": { + "tagName": "client@${version}" + } +} \ No newline at end of file diff --git a/packages/json/.release-it.json b/packages/json/.release-it.json new file mode 100644 index 0000000000..3486f4456a --- /dev/null +++ b/packages/json/.release-it.json @@ -0,0 +1,5 @@ +{ + "git": { + "tagName": "json@${version}" + } +} \ No newline at end of file diff --git a/packages/search/.release-it.json b/packages/search/.release-it.json new file mode 100644 index 0000000000..c181fc970b --- /dev/null +++ b/packages/search/.release-it.json @@ -0,0 +1,5 @@ +{ + "git": { + "tagName": "search@${version}" + } +} \ No newline at end of file