Skip to content

Commit

Permalink
docs: improve nightly release usage section (#468)
Browse files Browse the repository at this point in the history
Co-authored-by: Pooya Parsa <pooya@pi0.io>
  • Loading branch information
Hebilicious and pi0 authored Jul 28, 2023
1 parent 9bd85a3 commit 51ec2bb
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,40 @@ pnpm add h3
<details>
<summary>Using Nightly Releases</summary>

You can try latest changes of h3 landing to the `main` branch by using [`h3-nightly`](https://www.npmjs.com/package/h3-nightly) package.

You can directly swap from `h3` to `h3-nightly` for both dependency and imports, or use `resolutions` feature in `package.json` (recommanded):
If you are directly using `h3` as a dependency:

```json
{
"dependencies": {
"h3": "latest"
},
"h3": "npm:h3-nightly@latest"
}
}
```

If you are using a framework ([Nuxt](https://nuxt.com/) or [Nitro](https://nitro.unjs.io/)) that is using `h3`:

pnpm and yarn:

```json
{
"resolutions": {
"h3": "npm:h3-nightly@latest"
}
}
```

npm:

```json
{
"overrides": {
"h3": "npm:h3-nightly@latest"
}
}
```

**Note:** Make sure to recreate lockfile and `node_modules` after reinstall to avoid hoisting issues.

</details>

## Usage
Expand Down

0 comments on commit 51ec2bb

Please sign in to comment.