Skip to content

Commit

Permalink
doc: Add version compatibility table
Browse files Browse the repository at this point in the history
  • Loading branch information
franky47 committed Nov 14, 2023
1 parent 5fb24d1 commit 87acf5c
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,17 @@ $ yarn add next-usequerystate
$ npm install next-usequerystate
```

> Note: version 1.8.0 requires Next.js 13.4+.
> [!WARNING]
> Due to a bug introduced in `[email protected]`, this library is currently
> **not** compatible with `next@^14.0.2`.
>
> Follow PR [#58297](https://github.com/vercel/next.js/pull/58297)
> and issue [#388](https://github.com/47ng/next-usequerystate/issues/388)
> for updates.
<details>
<summary>Which version should I use?</summary>

Depending on your Next.js version:

- Next.js <= 13.1: `[email protected]`
- Next.js >= 13.4 && <= 14.0.1: `next-usequerystate@latest`
- Next.js 14.0.2: Unfortunately not compatible due to a bug introduced in `[email protected]`, see issue [#388](https://github.com/47ng/next-usequerystate/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297).
- Next.js >= 14.0.3-canary-6: `next-usequerystate@latest` with the experimental flag [`windowHistorySupport`](https://github.com/vercel/next.js/pull/58335) set to `true`.

</details>

## Usage

Expand Down

0 comments on commit 87acf5c

Please sign in to comment.