From d37dc4f0806587fba95b6bf9b218b4984c29efc5 Mon Sep 17 00:00:00 2001 From: James Kim Date: Fri, 17 Nov 2023 12:12:58 -0500 Subject: [PATCH] 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 <35093316+gskril@users.noreply.github.com> --- README.md | 4 ++-- docs/src/pages/index.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e1e6e10e..a5f8a6be 100644 --- 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 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. diff --git a/docs/src/pages/index.mdx b/docs/src/pages/index.mdx index fb430f3f..1748ea4c 100644 --- 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 react-transition-state@1.1.5 ``` ## Set Up