diff --git a/README.md b/README.md index a398f79..0ccdd54 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## version ~ 0.2.6 -Читать на русском README +ЧИТАТЬ НА РУССКОМ This component allows you to create a custom select. It offers more flexible customization and use of select. Customization, multi-selection and live search by elements are available. diff --git a/READMERU.md b/READMERU.md index a70d1b1..5d7e9f5 100644 --- a/READMERU.md +++ b/READMERU.md @@ -1,8 +1,8 @@ # CG-SELECT -## version ~ 0.2.6 +## Версия ~ 0.2.6 -Вернуться к английской версии README +English README Этот компонент позволяет вам создать пользовательский Select. Он предлагает более гибкую настройку и использование select. Доступна кастомизация, multi-selection, живой поиск по элементам и многое другое. @@ -17,13 +17,13 @@ - Переключить тему с темной на светлую. - Так же в документации указанны все элементы для катомизации с помощью CSS. -## Installation +## Установка ``` npm i cg-select ``` -## Usage +## Использование ### Для создания компонента необходимо: @@ -76,22 +76,22 @@ const dropdown = new CGSelect({ Документация -## Contributing +## Содействие -1. Fork it! -2. Create your feature branch: `git checkout -b my-new-feature` -3. Commit your changes: `git commit -am 'Add some feature'` -4. Push to the branch: `git push origin my-new-feature` -5. Submit a pull request :D +1. Сделайте Fork! +2. Создайте свою ветку: `git checkout -b my-new-feature` +3. Зафиксируйте свои изменения: `git commit -am 'Add some feature'` +4. Загрузите ветку: `git push origin my-new-feature` +5. Отправте запрос на вытягивание изменений :D -## Compatibility +## Совместимость -| Application Compatibility | JS | React | Angular | Vue | -| ------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: | -| CG-SELECT | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | -| Comment | Tested in Js applications and it worksуспешно. | Works only with a crutch in the form `setTimeout()` | not yet available | not yet available | +| Совместимость в приложениях | JS | React | Angular | Vue | +| --------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: | +| CG-SELECT | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | +| Комментарий | Протестировано в Js приложениях | Работает только с костылем в виде `setTimeout()` | пока недоступно | пока недоступно | -## History +## История 16.12.2022 - release version 0.1.0!