Skip to content

Commit

Permalink
add instructions to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Jul 27, 2023
1 parent 4ae826c commit c65559a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,28 @@ yarn add h3
pnpm add h3
```

<details>
<summary>Using Nightly Releases</summary>

### Nightly Releases

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 package, or use `resolutions` field in `package.json` to alias: (Hightly recommanded):

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

</details>

## Usage

```ts
Expand Down

0 comments on commit c65559a

Please sign in to comment.