Update installation instructions to include peer dependencies (#133)

* 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 <[email protected]>
ensdomains · Nov 17, 2023 · d37dc4f · d37dc4f
1 parent 6ef5e0d
commit d37dc4f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -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 [email protected]
 
 ```
 
 To install this package using yarn:
 
 ```bash
-yarn add @ensdomains/thorin
+yarn add @ensdomains/thorin styled-components [email protected]
 ```
 
 Checkout the project's [playroom](https://thorin.ens.domains/playroom) to preview the components in a live online environment.

diff --git a/docs/src/pages/index.mdx b/docs/src/pages/index.mdx
@@ -14,7 +14,7 @@ import { Header, Link } from '~/components'
 ## Install
 
 ```bash
-yarn add @ensdomains/thorin
+yarn add @ensdomains/thorin styled-components [email protected]
 ```
 
 ## Set Up