Skip to content

Commit

Permalink
Update installation instructions to include peer dependencies (#133)
Browse files Browse the repository at this point in the history
* Update installation instructions to include peer dependencies

`@ensdomains/thorin` requires peer dependencies `styled-components` and `react-transition-state` but these are not listed in the initial install instructions

* update readme with peer deps

* Specify version of peer dep

Some animations don't work with react-transition-state v2

---------

Co-authored-by: Greg Skriloff <35093316+gskril@users.noreply.github.com>
  • Loading branch information
jakim929 and gskril committed Nov 17, 2023
1 parent 6ef5e0d commit d37dc4f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -9,14 +9,14 @@ A design system for ENS built with React and styled-components.
To install this package using npm:

```bash
npm install @ensdomains/thorin
npm install @ensdomains/thorin styled-components react-transition-state@1.1.5

```

To install this package using yarn:

```bash
yarn add @ensdomains/thorin
yarn add @ensdomains/thorin styled-components react-transition-state@1.1.5
```

Checkout the project's [playroom](https://thorin.ens.domains/playroom) to preview the components in a live online environment.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/index.mdx
Expand Up @@ -14,7 +14,7 @@ import { Header, Link } from '~/components'
## Install

```bash
yarn add @ensdomains/thorin
yarn add @ensdomains/thorin styled-components react-transition-state@1.1.5
```

## Set Up
Expand Down

0 comments on commit d37dc4f

Please sign in to comment.