Skip to content

Commit

Permalink
wip: tweaks readme for development
Browse files Browse the repository at this point in the history
  • Loading branch information
marlonmarcello committed Nov 28, 2023
1 parent 88492bd commit e23a7f0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,24 @@ A collection of helpers for use in React projects.

### Setup

Clone repo, make sure you are using the correct version of [Node](./.nvmrc), and install dependencies:

```bash
git clone
cd react-hooks
yarn
```

### Running the docs

This will make Vite run a production build with `--watch` so you can develop the docs while still being able to tweak the hooks.
This will make Vite run a production build with `--watch` for the **hooks** so you can develop the docs while still being able to tweak them.

```bash
yarn start
```

### Running the package and playground

If you'd like to work on hooks in isolation and see them in action, you can run the playground:

```bash
cd packages/wethegit-react-hooks
yarn dev
Expand Down

0 comments on commit e23a7f0

Please sign in to comment.