Skip to content

docs: migration guide to README.md #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2024
Merged

docs: migration guide to README.md #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,14 @@ This library provides utility functions to deal with **Parsed Query Objects**
このライブラリには、**Parsed Query Object** （特に Next.js
のもの）を取り扱うためのユーティリティ関数群が含まれます。

## Links — リンク集
## Migration from v1 to v2

- [API Documentions — APIドキュメント](https://honey32.github.io/next-query-utils/)
As the only difference; v2 is provided as
[`@honey32/next-query-utils` via JSR](https://jsr.io/@honey32/next-query-utils),
while v1 as `next-query-utils` via npm.

# Install

```sh
// with npm
npm i next-query-utils

// with yarn
yarn add next-query-utils
```
When you try to migrate from npm to JSR, see:
https://jsr.io/docs/npm-compatibility

# Usages — 使い方

Expand Down