From 677ea6c51cffdd5f2a786e8123ca922f58d56522 Mon Sep 17 00:00:00 2001 From: shaharzil Date: Thu, 4 Apr 2024 12:05:22 +0300 Subject: [PATCH] fixed pr comments --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++---- README.md | 11 +++++------ packages/core/README.md | 2 +- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1832f447a4..e6ad80086a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,6 @@ -# Pull Request Template - -Thank you for contributing! + - [ ] I have read the [Contribution Guide](../packages/core/CONTRIBUTING.md) for this project. diff --git a/README.md b/README.md index 340a609801..a82bb71473 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,17 @@ Welcome to the Vibe Design System repository! This monorepo contains various ope ## Overview -Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages: +Vibe Design System is a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages: -1. [core](packages/core/README.md): [monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com). -2. [style](packages/style/README.md): [monday.com](https://www.monday.com) styling foundations library. +1. [core](packages/core/README.md): Vibe ([monday.com](https://www.monday.com)) React components library - [Storybook](https://style.monday.com). +2. [style](packages/style/README.md): Vibe ([monday.com](https://www.monday.com)) styling foundations library. +3. [storybook-blocks](packages/storybook-blocks/README.md): Vibe ([monday.com](https://www.monday.com)) collection of Storybook blocks library. Each package comes with its own README providing detailed information about its usage, installation instructions, and getting started guide. ## Installation -Install the component library - -``` +```bash npm install monday-ui-react-core ``` diff --git a/packages/core/README.md b/packages/core/README.md index 56080206f6..dd6d02806b 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -75,4 +75,4 @@ npm start ## Themes -We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file +Theming is supported using CSS variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file