From c5c7893f4814f3e40142d55628050f1dbde93de8 Mon Sep 17 00:00:00 2001 From: Nik Tverd <61203447+niktverd@users.noreply.github.com> Date: Thu, 28 Sep 2023 23:57:14 +0600 Subject: [PATCH] docs: add information about peer dependencies, and fix broken link on storybook (#605) --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 092b00aa0..3ef46f997 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ When creating pages, component-based approach is used: a page is built using a set of ready-made blocks that can be placed in any order. Each block has a certain type and set of input data parameters. -For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/story/information--blocks). +For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/docs/documentation-blocks--docs). ## Install @@ -14,6 +14,10 @@ For the format of input data and list of available blocks, see the [documentatio npm install @gravity-ui/page-constructor ``` +## Required dependencies + +Please note that to start using the package, your project must also have the following installed: `@doc-tools/transform`, `@gravity-ui/uikit`, `react`. Check out the `peerDependencies` section of `package.json` for accurate information. + ### Getting started The page constructor is imported as a React component. To make sure it runs properly, wrap it in `PageConstructorProvider`: