Skip to content

Commit

Permalink
Move install to beginning of README
Browse files Browse the repository at this point in the history
  • Loading branch information
lukahartwig committed Jun 29, 2023
1 parent 8149b4d commit fdeed35
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .changeset/neat-icons-appear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-hook-form-zod": patch
---

Puts install instructions at the beginning of README and adds copy paste commands for yarn and pnpm
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ and [zod](https://zod.dev/) to create forms with validation.

Its primary purpose is to reduce the boilerplate required to use zod with react-hook-form.

## Install

```bash
npm install react-hook-form-zod zod
```

```bash
yarn add react-hook-form-zod zod
```

```bash
pnpm add react-hook-form-zod zod
```

## Usage

WITHOUT react-hook-form-zod:
Expand Down Expand Up @@ -49,12 +63,6 @@ function Form() {
}
```

## Installation

```bash
npm install react-hook-form-zod zod
```

## API Reference

The API is identical to react-hook-form with the exception of the `useForm` hook.
Expand Down

0 comments on commit fdeed35

Please sign in to comment.