Skip to content

Commit

Permalink
docs(README): Explain how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
janpio authored Aug 22, 2023
1 parent 6a278bc commit 872f414
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down

0 comments on commit 872f414

Please sign in to comment.