chore: cleanup READMEs for all packages [skip ci] (#2336)

vaadin · Aug 13, 2021 · bb03bae · bb03bae
1 parent 02fdef0
commit bb03bae
Show file tree

Hide file tree

Showing 48 changed files with 161 additions and 2,311 deletions.
diff --git a/README.md b/README.md
@@ -143,6 +143,10 @@ Are you looking for an example project to get started? Visit [start.vaadin.com](
 
 For help and support questions, please use our [community chat](https://vaad.in/chat).
 
+## Big Thanks
+
+Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
+
 ## Contributing
 
 Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.

diff --git a/packages/vaadin-accordion/README.md b/packages/vaadin-accordion/README.md
@@ -7,10 +7,7 @@
 [API documentation ↗](https://vaadin.com/components/vaadin-accordion/html-api)
 
 [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-accordion)](https://www.npmjs.com/package/@vaadin/vaadin-accordion)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-accordion.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-accordion)
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-accordion)
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-accordion)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadin-accordion-directory-urlidentifier.svg)](https://vaadin.com/directory/component/vaadinvaadin-accordion)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -28,7 +25,6 @@
 
 [<img src="https://raw.githubusercontent.com/vaadin/vaadin-accordion/master/screenshot.png" alt="Screenshot of vaadin-accordion" width="900">](https://vaadin.com/components/vaadin-accordion)
 
-
 ## Installation
 
 Install `vaadin-accordion`:
@@ -63,44 +59,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
 
   `vaadin-accordion.js`
 
-## Running API docs and tests in a browser
-
-1. Fork the `vaadin-accordion` repository and clone it locally.
-
-1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
-
-1. Make sure you have [npm](https://www.npmjs.com/) installed.
-
-1. When in the `vaadin-accordion` directory, run `npm install` to install dependencies.
-
-1. Run `npm start`, browser will automatically open the component API documentation.
-
-1. You can also open visual tests, for example:
-
-  - http://localhost:8000/test/visual/accordion.html
-
-## Running tests from the command line
-
-1. When in the `vaadin-accordion` directory, run `npm test`
-
-## Debugging tests in the browser
-
-1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
-
-## Following the coding style
-
-We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files.
-
-
-## Big Thanks
-
-Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
-
-
 ## Contributing
 
-To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
-
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License
 

diff --git a/packages/vaadin-app-layout/README.md b/packages/vaadin-app-layout/README.md
@@ -7,10 +7,7 @@
 [&lt;vaadin-app-layout&gt;](https://vaadin.com/components/vaadin-app-layout) is a Web Component providing a quick and easy way to get a common application layout structure done, part of the [Vaadin components](https://vaadin.com/components).
 
 [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-app-layout)](https://www.npmjs.com/package/@vaadin/vaadin-app-layout)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-app-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-app-layout)
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-app-layout)
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-app-layout)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadin-app-layout-directory-urlidentifier.svg)](https://vaadin.com/directory/component/vaadinvaadin-app-layout)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -39,7 +36,6 @@
 
 [<img src="https://raw.githubusercontent.com/vaadin/vaadin-app-layout/master/screenshot-mobile.png" width="350" alt="Screenshot of vaadin-app-layout on mobile">](https://vaadin.com/components/vaadin-app-layout)
 
-
 ## Installation
 
 Install `vaadin-app-layout`:
@@ -78,39 +74,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
   `vaadin-app-layout.js`
   `vaadin-drawer-toggle.js`
 
-## Running API docs and tests in a browser
-
-1. Fork the `vaadin-app-layout` repository and clone it locally.
-
-1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
-
-1. Make sure you have [npm](https://www.npmjs.com/) installed.
-
-1. When in the `vaadin-app-layout` directory, run `npm install` to install dependencies.
-
-1. Run `npm start`, browser will automatically open the component API documentation.
-
-1. You can also open visual tests, for example:
-
-  - http://localhost:8000/test/visual/drawer.html
-
-
-## Running tests from the command line
-
-1. When in the `vaadin-app-layout` directory, run `npm test`
-
-## Debugging tests in the browser
-
-1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
-
-## Following the coding style
-
-We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files.
-
-
 ## Contributing
 
-To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License
 

diff --git a/packages/vaadin-avatar/README.md b/packages/vaadin-avatar/README.md
@@ -7,10 +7,7 @@
 [API documentation ↗](https://vaadin.com/components/vaadin-avatar/html-api)
 
 [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-avatar)](https://www.npmjs.com/package/@vaadin/vaadin-avatar)
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-avatar)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-avatar.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-avatar)
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-avatar)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadin-avatar-directory-urlidentifier.svg)](https://vaadin.com/directory/component/vaadinvaadin-avatar)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -20,16 +17,15 @@
 <vaadin-avatar-group max="2"></vaadin-avatar-group>
 <script>
   document.querySelector('vaadin-avatar-group').items = [
-    {name: 'Foo Bar', colorIndex: 1},
-    {colorIndex: 2},
-    {name: 'Foo Bar', colorIndex: 3}
+    { name: 'Foo Bar', colorIndex: 1 },
+    { colorIndex: 2 },
+    { name: 'Foo Bar', colorIndex: 3 }
   ];
 </script>
 ```
 
 [<img src="https://raw.githubusercontent.com/vaadin/vaadin-avatar/master/screenshot.png" width="200" alt="Screenshot of vaadin-avatar">](https://vaadin.com/components/vaadin-avatar)
 
-
 ## Installation
 
 Install `vaadin-avatar`:
@@ -68,46 +64,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
   `vaadin-avatar.js`
   `vaadin-avatar-group.js`
 
-
-## Running API docs and tests in a browser
-
-1. Fork the `vaadin-avatar` repository and clone it locally.
-
-1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
-
-1. Make sure you have [npm](https://www.npmjs.com/) installed.
-
-1. When in the `vaadin-avatar` directory, run `npm install` to install dependencies.
-
-1. Run `npm start`, browser will automatically open the component API documentation.
-
-1. You can also open visual tests, for example:
-
-  - http://127.0.0.1:3000/test/visual/default.html
-
-
-## Running tests from the command line
-
-1. When in the `vaadin-avatar` directory, run `npm test`
-
-## Debugging tests in the browser
-
-1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
-
-## Following the coding style
-
-We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files.
-
-
-## Big Thanks
-
-Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
-
-
 ## Contributing
 
-To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
-
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License
 

diff --git a/packages/vaadin-board/README.md b/packages/vaadin-board/README.md
@@ -8,9 +8,7 @@
 Vaadin Board key feature is how it effectively reorders the widgets on different screen sizes, maximizing the use of space and looking stunning.
 
 [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-board)](https://www.npmjs.com/package/@vaadin/vaadin-board)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-board.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-board)
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-board)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadinvaadin-board.svg)](https://vaadin.com/directory/component/vaadinvaadin-board)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -37,8 +35,7 @@ Vaadin Board key feature is how it effectively reorders the widgets on different
 
 [<img src="https://raw.githubusercontent.com/vaadin/vaadin-board/master/screenshot.png" alt="Screenshot of vaadin-board">](https://vaadin.com/components/vaadin-board)
 
-
-### Installation
+## Installation
 
 Install `vaadin-board`:
 
@@ -52,35 +49,9 @@ Once installed, import it in your application:
 import '@vaadin/vaadin-board/vaadin-board.js';
 ```
 
-## Running API docs in a browser
-
-1. Fork the `vaadin-board` repository and clone it locally.
-
-1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
-
-1. Make sure you have [npm](https://www.npmjs.com/) installed.
-
-1. When in the `vaadin-board` directory, run `npm install` to install dependencies.
-
-1. Run `npm start`, browser will automatically open the component API documentation.
-
-## Running tests from the command line
-
-1. When in the `vaadin-board` directory, run `npm test`
-
-## Debugging tests in the browser
-
-1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
-
-## Following the coding style
-
-We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files.
-
-
 ## Contributing
 
-  To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
-
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License
 

diff --git a/packages/vaadin-button/README.md b/packages/vaadin-button/README.md
@@ -7,10 +7,7 @@
 [&lt;vaadin-button&gt;](https://vaadin.com/components/vaadin-button) is a Web Component providing an accessible and customizable button, part of the [Vaadin components](https://vaadin.com/components).
 
 [![npm version](https://badgen.net/npm/v/@vaadin/vaadin-button)](https://www.npmjs.com/package/@vaadin/vaadin-button)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-button.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-button)
-[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-button)
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-button)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadinvaadin-button.svg)](https://vaadin.com/directory/component/vaadinvaadin-button)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -55,46 +52,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
 
   `vaadin-button.js`
 
-## Running API docs and tests in a browser
-
-1. Fork the `vaadin-button` repository and clone it locally.
-
-1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
-
-1. Make sure you have [npm](https://www.npmjs.com/) installed.
-
-1. When in the `vaadin-button` directory, run `npm install` to install dependencies.
-
-1. Run `npm start`, browser will automatically open the component API documentation.
-
-1. You can also open visual tests, for example:
-
-  - http://127.0.0.1:3000/test/visual/default.html
-
-
-## Running tests from the command line
-
-1. When in the `vaadin-button` directory, run `npm test`
-
-## Debugging tests in the browser
-
-1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
-
-
-## Following the coding style
-
-We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run lint`, which will automatically lint all `.js` files.
-
-
-## Big Thanks
-
-Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
-
-
 ## Contributing
 
-  To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
-
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License