summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJouni Koivuviita <jouni@vaadin.com>2021-11-12 15:10:47 +0200
committerGitHub <noreply@github.com>2021-11-12 15:10:47 +0200
commit2c7fcd3b9391d6a438d1263c16aaeef8cb22f9ca (patch)
treef8fe86daef99a468c93e4632f2c5f8650b66114a /README.md
parentf6d885c2bcc31f5f95b7fe6c4558a84af0f26cb9 (diff)
downloadvaadin-2c7fcd3b9391d6a438d1263c16aaeef8cb22f9ca.tar.gz
vaadin-2c7fcd3b9391d6a438d1263c16aaeef8cb22f9ca.zip
Update README.md (#79)
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md95
1 files changed, 3 insertions, 92 deletions
diff --git a/README.md b/README.md
index ca3c011..dfcb379 100644
--- a/README.md
+++ b/README.md
@@ -1,94 +1,5 @@
-![Bower version](https://badge.fury.io/bo/vaadin.svg)
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/search?framework=Polymer%202&keyword=vaadin)
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/author/vaadin)
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+# Vaadin web components
-# Vaadin components
+This package contains all Vaadin web components (free and commercial).
-[Vaadin components](https://vaadin.com/components) is an evolving set of high-quality user interface web components commonly needed in modern mobile and desktop business web applications. The following components are included:
-
-## Core Components
-
-The components below are licensed under the Apache License 2.0.
-
-| Component | Build Status | Polymer 3 (stable) | LitElement (next) |
-|-----------|--------------|--------------------|-------------------|
-| [vaadin-accordion](https://github.com/vaadin/vaadin-accordion) | [![Build Status](https://travis-ci.org/vaadin/vaadin-accordion.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-accordion) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-accordion)](https://www.npmjs.com/package/@vaadin/vaadin-accordion) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-accordion/next)](https://www.npmjs.com/package/@vaadin/vaadin-accordion) |
-| [vaadin-app-layout](https://github.com/vaadin/vaadin-app-layout) | [![Build Status](https://travis-ci.org/vaadin/vaadin-app-layout.svg?branch=next)](https://travis-ci.org/vaadin/vaadin-app-layout) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-app-layout)](https://www.npmjs.com/package/@vaadin/vaadin-app-layout) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-app-layout/next)](https://www.npmjs.com/package/@vaadin/vaadin-app-layout) |
-| [vaadin-button](https://github.com/vaadin/vaadin-button) | [![Build Status](https://travis-ci.org/vaadin/vaadin-button.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-button) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-button)](https://www.npmjs.com/package/@vaadin/vaadin-button) | |
-| [vaadin-checkbox](https://github.com/vaadin/vaadin-checkbox) | [![Build Status](https://travis-ci.org/vaadin/vaadin-checkbox.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-checkbox) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-checkbox)](https://www.npmjs.com/package/@vaadin/vaadin-checkbox) | |
-| [vaadin-combo-box](https://github.com/vaadin/vaadin-combo-box) | [![Build Status](https://travis-ci.org/vaadin/vaadin-combo-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-combo-box) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-combo-box)](https://www.npmjs.com/package/@vaadin/vaadin-combo-box) | |
-| [vaadin-context-menu](https://github.com/vaadin/vaadin-context-menu) | [![Build Status](https://travis-ci.org/vaadin/vaadin-context-menu.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-context-menu) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-context-menu)](https://www.npmjs.com/package/@vaadin/vaadin-context-menu) | |
-| [vaadin-custom-field](https://github.com/vaadin/vaadin-custom-field) | [![Build Status](https://travis-ci.org/vaadin/vaadin-custom-field.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-custom-field) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-custom-field)](https://www.npmjs.com/package/@vaadin/vaadin-custom-field) | |
-| [vaadin-date-picker](https://github.com/vaadin/vaadin-date-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-date-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-date-picker) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-date-picker)](https://www.npmjs.com/package/@vaadin/vaadin-date-picker) | |
-| [vaadin-date-time-picker](https://github.com/vaadin/vaadin-date-time-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-date-time-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-date-time-picker) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-date-time-picker)](https://www.npmjs.com/package/@vaadin/vaadin-date-time-picker) | |
-| [vaadin-details](https://github.com/vaadin/vaadin-details) | [![Build Status](https://travis-ci.org/vaadin/vaadin-details.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-details) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-details)](https://www.npmjs.com/package/@vaadin/vaadin-details) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-details/next)](https://www.npmjs.com/package/@vaadin/vaadin-details) |
-| [vaadin-dialog](https://github.com/vaadin/vaadin-dialog) | [![Build Status](https://travis-ci.org/vaadin/vaadin-dialog.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-dialog) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-dialog)](https://www.npmjs.com/package/@vaadin/vaadin-dialog) | |
-| [vaadin-form-layout](https://github.com/vaadin/vaadin-form-layout) | [![Build Status](https://travis-ci.org/vaadin/vaadin-form-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-form-layout) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-form-layout)](https://www.npmjs.com/package/@vaadin/vaadin-form-layout) | |
-| [vaadin-grid](https://github.com/vaadin/vaadin-grid) | [![Build Status](https://travis-ci.org/vaadin/vaadin-grid.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-grid) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-grid)](https://www.npmjs.com/package/@vaadin/vaadin-grid) | |
-| [vaadin-icons](https://github.com/vaadin/vaadin-icons) | [![Build status](https://travis-ci.org/vaadin/vaadin-icons.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-icons) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-icons)](https://www.npmjs.com/package/@vaadin/vaadin-icons) | |
-| [vaadin-item](https://github.com/vaadin/vaadin-item) | [![Build Status](https://travis-ci.org/vaadin/vaadin-item.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-item) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-item)](https://www.npmjs.com/package/@vaadin/vaadin-item) | |
-| [vaadin-list-box](https://github.com/vaadin/vaadin-list-box) | [![Build Status](https://travis-ci.org/vaadin/vaadin-list-box.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-list-box) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-list-box)](https://www.npmjs.com/package/@vaadin/vaadin-list-box) | |
-| [vaadin-login](https://github.com/vaadin/vaadin-login) | [![Build Status](https://travis-ci.org/vaadin/vaadin-login.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-login) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-login)](https://www.npmjs.com/package/@vaadin/vaadin-login) | |
-| [vaadin-menu-bar](https://github.com/vaadin/vaadin-menu-bar) | [![Build Status](https://travis-ci.org/vaadin/vaadin-menu-bar.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-menu-bar) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-menu-bar)](https://www.npmjs.com/package/@vaadin/vaadin-menu-bar) | |
-| [vaadin-notification](https://github.com/vaadin/vaadin-notification) | [![Build Status](https://travis-ci.org/vaadin/vaadin-notification.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-notification) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-notification)](https://www.npmjs.com/package/@vaadin/vaadin-notification) | |
-| [vaadin-ordered-layout](https://github.com/vaadin/vaadin-ordered-layout) | [![Build Status](https://travis-ci.org/vaadin/vaadin-ordered-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-ordered-layout) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-ordered-layout)](https://www.npmjs.com/package/@vaadin/vaadin-ordered-layout) | |
-| [vaadin-progress-bar](https://github.com/vaadin/vaadin-progress-bar) | [![Build status](https://travis-ci.org/vaadin/vaadin-progress-bar.svg?branch=next)](https://travis-ci.org/vaadin/vaadin-progress-bar) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-progress-bar)](https://www.npmjs.com/package/@vaadin/vaadin-progress-bar) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-progress-bar/next)](https://www.npmjs.com/package/@vaadin/vaadin-progress-bar) |
-| [vaadin-radio-button](https://github.com/vaadin/vaadin-radio-button) | [![Build status](https://travis-ci.org/vaadin/vaadin-radio-button.svg?branch=next)](https://travis-ci.org/vaadin/vaadin-radio-button) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-radio-button)](https://www.npmjs.com/package/@vaadin/vaadin-radio-button) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-radio-button/next)](https://www.npmjs.com/package/@vaadin/vaadin-radio-button) |
-| [vaadin-select](https://github.com/vaadin/vaadin-select) | [![Build status](https://travis-ci.org/vaadin/vaadin-select.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-select) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-select)](https://www.npmjs.com/package/@vaadin/vaadin-select) | |
-| [vaadin-split-layout](https://github.com/vaadin/vaadin-split-layout) | [![Build status](https://travis-ci.org/vaadin/vaadin-split-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-split-layout) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-split-layout)](https://www.npmjs.com/package/@vaadin/vaadin-split-layout) | |
-| [vaadin-tabs](https://github.com/vaadin/vaadin-tabs) | [![Build Status](https://travis-ci.org/vaadin/vaadin-tabs.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-tabs) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-tabs)](https://www.npmjs.com/package/@vaadin/vaadin-tabs) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-tabs/next)](https://www.npmjs.com/package/@vaadin/vaadin-tabs) |
-| [vaadin-text-field](https://github.com/vaadin/vaadin-text-field) | [![Build Status](https://travis-ci.org/vaadin/vaadin-text-field.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-text-field) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-text-field)](https://www.npmjs.com/package/@vaadin/vaadin-text-field) | |
-| [vaadin-time-picker](https://github.com/vaadin/vaadin-time-picker) | [![Build Status](https://travis-ci.org/vaadin/vaadin-time-picker.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-time-picker) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-time-picker)](https://www.npmjs.com/package/@vaadin/vaadin-time-picker) | |
-| [vaadin-upload](https://github.com/vaadin/vaadin-upload) | [![Build Status](https://travis-ci.org/vaadin/vaadin-upload.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-upload) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-upload)](https://www.npmjs.com/package/@vaadin/vaadin-upload) | |
-
-## Pro Components
-
-The components below are part of the [Vaadin Pro Subscription](https://vaadin.com/pricing).
-
-| Component | Build Status | Polymer 3 (stable) | LitElement (next) |
-|-----------|--------------|--------------------|-------------------|
-| [vaadin-board](https://github.com/vaadin/vaadin-board) | [![Build Status](https://travis-ci.org/vaadin/vaadin-board.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-board) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-board)](https://www.npmjs.com/package/@vaadin/vaadin-board) | |
-| [vaadin-charts](https://github.com/vaadin/vaadin-charts) | [![Build Status](https://travis-ci.org/vaadin/vaadin-charts.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-charts) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-charts)](https://www.npmjs.com/package/@vaadin/vaadin-charts) | |
-| [vaadin-confirm-dialog](https://github.com/vaadin/vaadin-confirm-dialog) | [![Build Status](https://travis-ci.org/vaadin/vaadin-confirm-dialog.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-confirm-dialog) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-confirm-dialog)](https://www.npmjs.com/package/@vaadin/vaadin-confirm-dialog) | |
-| [vaadin-cookie-consent](https://github.com/vaadin/vaadin-cookie-consent) | [![Build Status](https://travis-ci.org/vaadin/vaadin-cookie-consent.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-cookie-consent) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-cookie-consent)](https://www.npmjs.com/package/@vaadin/vaadin-cookie-consent) | |
-| [vaadin-crud](https://github.com/vaadin/vaadin-crud) | [![Build Status](https://travis-ci.org/vaadin/vaadin-crud.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-crud) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-crud)](https://www.npmjs.com/package/@vaadin/vaadin-crud) | |
-| [vaadin-grid-pro](https://github.com/vaadin/vaadin-grid-pro) | [![Build Status](https://travis-ci.org/vaadin/vaadin-grid-pro.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-grid-pro) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-grid-pro)](https://www.npmjs.com/package/@vaadin/vaadin-grid-pro) | |
-| [vaadin-rich-text-editor](https://github.com/vaadin/vaadin-rich-text-editor) | [![Build Status](https://travis-ci.org/vaadin/vaadin-rich-text-editor.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-rich-text-editor) | [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-rich-text-editor)](https://www.npmjs.com/package/@vaadin/vaadin-rich-text-editor) | |
-
-## Learn more
-
-See demos and documentation, instructions how to get started, video tutorials, application demos and more by visiting:
-
-### [vaadin.com/components ›](https://vaadin.com/components)
-
----
-
-## Contributing
-
-We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components.
-
-### Get in touch with the team
-
-The chat and the forum category are dedicated channels for this project, while the Twitter and Facebook pages are common for all Vaadin related discussion (including the Java framework).
-
-- [Chat](https://gitter.im/vaadin/web-components)
-- [Forum](https://vaadin.com/forum/category/9848927)
-- [Twitter](https://twitter.com/vaadin)
-- [Facebook](https://www.facebook.com/vaadin/)
-
-### Some ways to help:
-
-- **Test the components and provide feedback**: We would love to hear your feedback on anything related to the components, like features, API and design. The best way to start is by [trying them out](https://vaadin.com/components/browse). And to get a quick response, either drop a question/comment on the chat or open an issue in GitHub.
-- **Report bugs**: File issues for the components in their respective GitHub projects. You can find links to them from the list in this readme.
-- **Send pull requests**: If you want to contribute code, check out the development instructions below.
-
-We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
-
-## Development
-
-If you want to develop the components yourself see the [development instructions](DEVELOPMENT.md) that apply to all Vaadin components.
-
-## License
-
-Apache License 2.0 or CVAL 3.0 depending on the component
+See https://github.com/vaadin/web-components for more details.