From 872f414bbb72514bdd344e35338e830cb53bccb1 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Tue, 22 Aug 2023 09:51:19 +0200 Subject: [PATCH] docs(README): Explain how it works --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a01378c..1ff71e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # @prisma/extension-read-replicas -This [Prisma Client Extension](https://www.prisma.io/docs/concepts/components/prisma-client/client-extensions) adds read replica support to your Prisma Client. +This [Prisma Client Extension](https://www.prisma.io/docs/concepts/components/prisma-client/client-extensions) adds read replica support to your Prisma Client. Under the hood, this extension creates additional Prisma Clients for the read replica database connection strings, and then routes read queries to these Clients instead of using the primary Prisma Client. ## Requirements @@ -10,19 +10,19 @@ Requires Prisma 5.2+. Depending on the package manager of your choice: -### `npm`: +### `npm` ```sh npm install @prisma/extension-read-replicas ``` -### `yarn`: +### `yarn` ```sh yarn add @prisma/extension-read-replicas ``` -### `pnpm`: +### `pnpm` ```sh pnpm add @prisma/extension-read-replicas