diff --git a/README.md b/README.md index d2edd26615..b98a290d04 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ -# @gravity-ui/uikit · [![npm package](https://img.shields.io/npm/v/@gravity-ui/uikit)](https://www.npmjs.com/package/@gravity-ui/uikit) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/uikit/.github/workflows/ci.yml?branch=main&label=CI&logo=github)](https://github.com/gravity-ui/uikit/actions/workflows/ci.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.gravity-ui.com/uikit/) +# UIKit · [![npm package](https://img.shields.io/npm/v/@gravity-ui/uikit)](https://www.npmjs.com/package/@gravity-ui/uikit) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/uikit/.github/workflows/ci.yml?branch=main&label=CI&logo=github)](https://github.com/gravity-ui/uikit/actions/workflows/ci.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.gravity-ui.com/uikit/) -A set of React components for building rich web applications. +A set of flexible, highly practical, and efficient React components for creating rich web applications. + + + +![Cover image](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/uikit_cover.png) + +## Resources + +### ![Globe Logo Light](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/globe_light.svg#gh-light-mode-only) ![Globe Logo Dark](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/globe_dark.svg#gh-dark-mode-only) [Website](https://gravity-ui.com) + +### ![Documentation Logo Light](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/book-open_light.svg#gh-light-mode-only) ![Documentation Logo Dark](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/book-open_dark.svg#gh-dark-mode-only) [Documentation](https://gravity-ui.com/components/uikit/alert) + +### ![Figma Logo Light](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/figma_light.svg#gh-light-mode-only) ![Figma Logo Dark](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/figma_dark.svg#gh-dark-mode-only) [Figma]() + +### ![Storybook Logo Light](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/storybook_light.svg#gh-light-mode-only) ![Storybook Logo Dark](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/storybook_dark.svg#gh-dark-mode-only) [Storybook](https://preview.gravity-ui.com/uikit/) + +### ![Community Logo Light](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/telegram_light.svg#gh-light-mode-only) ![Community Logo Dark](https://raw.githubusercontent.com/gravity-ui/uikit/main/docs/assets/telegram_dark.svg#gh-dark-mode-only) [Community](https://t.me/gravity_ui) + + ## Install diff --git a/docs/assets/book-open_dark.svg b/docs/assets/book-open_dark.svg new file mode 100644 index 0000000000..f816d5eee4 --- /dev/null +++ b/docs/assets/book-open_dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/book-open_light.svg b/docs/assets/book-open_light.svg new file mode 100644 index 0000000000..460a71c7cc --- /dev/null +++ b/docs/assets/book-open_light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/figma_dark.svg b/docs/assets/figma_dark.svg new file mode 100644 index 0000000000..ef7e29861a --- /dev/null +++ b/docs/assets/figma_dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/figma_light.svg b/docs/assets/figma_light.svg new file mode 100644 index 0000000000..4fa7a05f32 --- /dev/null +++ b/docs/assets/figma_light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/globe_dark.svg b/docs/assets/globe_dark.svg new file mode 100644 index 0000000000..e9809bc580 --- /dev/null +++ b/docs/assets/globe_dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/globe_light.svg b/docs/assets/globe_light.svg new file mode 100644 index 0000000000..c48e94e9e4 --- /dev/null +++ b/docs/assets/globe_light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/storybook_dark.svg b/docs/assets/storybook_dark.svg new file mode 100644 index 0000000000..f4bc0d4e35 --- /dev/null +++ b/docs/assets/storybook_dark.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/storybook_light.svg b/docs/assets/storybook_light.svg new file mode 100644 index 0000000000..ffea18da40 --- /dev/null +++ b/docs/assets/storybook_light.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/telegram_dark.svg b/docs/assets/telegram_dark.svg new file mode 100644 index 0000000000..f5f4188c11 --- /dev/null +++ b/docs/assets/telegram_dark.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/telegram_light.svg b/docs/assets/telegram_light.svg new file mode 100644 index 0000000000..b6dc323541 --- /dev/null +++ b/docs/assets/telegram_light.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/uikit_cover.png b/docs/assets/uikit_cover.png new file mode 100644 index 0000000000..8e989ff4ee Binary files /dev/null and b/docs/assets/uikit_cover.png differ