Skip to content

Commit

Permalink
Updated README (#14)
Browse files Browse the repository at this point in the history
Co-authored-by: Misha Topchilo <20854498+miksrv@users.noreply.github.com>
  • Loading branch information
miksrv and miksrv authored Oct 6, 2024
1 parent f9a14ef commit a8278b7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Welcome to the **Simple React UI Kit** repository! This project is designed to p
[![Release package](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/publish.yml/badge.svg)](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/publish.yml)
[![Deploy Storybook](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/storybook.yml/badge.svg)](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/storybook.yml)
[![Quality Gate](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/miksrv/simple-react-ui-kit/actions/workflows/sonarcloud.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=miksrv_simple-react-ui-kit&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=miksrv_simple-react-ui-kit)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=miksrv_simple-react-ui-kit&metric=coverage)](https://sonarcloud.io/summary/new_code?id=miksrv_simple-react-ui-kit)

Expand Down Expand Up @@ -66,6 +67,9 @@ The **Simple React UI Kit** is a collection of essential UI components for build
3. **Lightweight** – Minimal dependencies and easy to integrate into any project.
4. **Typescript Support** – Fully typed components for TypeScript users.

### Example Usage
One of the applications of this UI Kit is in the interface of a weather station. You can check out the demo here: [Weather Station Demo](https://meteo.miksoft.pro/). The source code for this project can be found in the repository: [Weather Station Repository](https://github.com/miksrv/arduino-weather-station).

<p align="right">
(<a href="#top">Back to top</a>)
</p>
Expand Down Expand Up @@ -168,8 +172,6 @@ In this example:

For more details and live examples, check out the [Storybook Documentation](https://miksrv.github.io/simple-react-ui-kit/?path=/docs/components-button--docs).

Вот пример раздела для компонента `Dropdown`:

### Dropdown Component

The `Dropdown` component provides a flexible, customizable dropdown menu for selecting options. It supports various features such as custom icons, images, placeholders, error messages, and a clearable state. It also handles clicks outside the dropdown to close it automatically.
Expand Down

0 comments on commit a8278b7

Please sign in to comment.