diff --git a/README.md b/README.md index 711ede4..d542138 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,15 @@ 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 @@ -24,6 +24,8 @@ 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