diff --git a/README.md b/README.md index e128b5a..f65ae18 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,28 @@ -[![Build Status](https://travis-ci.org/vaadin/vcf-tooltip.svg?branch=master)](https://travis-ci.org/vaadin/vcf-tooltip) +# <vcf-tooltip> Web Component [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-tooltip) -# <vcf-tooltip> +<vcf-tooltip> is a Web Component providing an easy way to display tooltips on any html element. -[Live Demo ↗](https://incubator.app.fi/vcf-tooltip-demo/) +[Live Demo ↗](https://incubator.app.fi/tooltip-demo/tooltip) +Screenshot of vcf-tooltip + +## Usage +Add <vcf-tooltip> element with attribute `for` which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed. -[<vcf-tooltip>](https://vaadin.com/directory/component/vaadinvcf-tooltip) is a Web Component providing an easy way to display tooltips on any html element. ```html + A short text describing the element. ``` -[Screenshot of vcf-tooltip](https://vaadin.com/components/vcf-tooltip) ## Installation -The Vaadin components are distributed as Bower and npm packages. -Please note that the version range is the same, as the API has not changed. -You should not mix Bower and npm versions in the same application, though. - -Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components -are only published on npm, not pushed to GitHub repositories. +This components is distributed as Bower packages. ### Polymer 2 and HTML Imports compatible version @@ -105,8 +104,10 @@ We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can c - [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description - Wait for response from one of Vaadin components team members +# Vaadin Prime +This component is available in Vaadin Prime subscription. It is still open source, but you need to have a valid CVAL license in order to use it. Read more at: https://vaadin.com/pricing -## License +# License Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE. diff --git a/vaadin-directory-description.md b/vaadin-directory-description.md index c61ed04..d4ea800 100644 --- a/vaadin-directory-description.md +++ b/vaadin-directory-description.md @@ -1,15 +1,4 @@ -# <vcf-tooltip> +## Usage +<vcf-tooltip> is a Web Component providing an easy way to display tooltips on any html element. -[<vcf-tooltip>](https://vaadin.com/directory/component/vaadinvcf-tooltip) is a Web Component providing an easy way to display tooltips on any html element. - -[Screenshot of vcf-tooltip](https://vaadin.com/directory/component/vaadinvcf-tooltip) - -## Example Usage - -```html - - A short text describing the element. - -``` - -[Live Demo ↗](https://incubator.app.fi/vcf-tooltip-demo/) \ No newline at end of file +Add <vcf-tooltip> element with attribute `for` which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed. \ No newline at end of file