Skip to content

Commit bb03bae

Browse files
authored
chore: cleanup READMEs for all packages [skip ci] (#2336)
1 parent 02fdef0 commit bb03bae

48 files changed

Lines changed: 161 additions & 2311 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,10 @@ Are you looking for an example project to get started? Visit [start.vaadin.com](
143143

144144
For help and support questions, please use our [community chat](https://vaad.in/chat).
145145

146+
## Big Thanks
147+
148+
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
149+
146150
## Contributing
147151

148152
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.

‎packages/vaadin-accordion/README.md‎

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@
77
[API documentation ↗](https://vaadin.com/components/vaadin-accordion/html-api)
88

99
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-accordion)](https://www.npmjs.com/package/@vaadin/vaadin-accordion)
10-
[![Build Status](https://travis-ci.org/vaadin/vaadin-accordion.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-accordion)
11-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-accordion)
1210
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-accordion)
13-
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadin-accordion-directory-urlidentifier.svg)](https://vaadin.com/directory/component/vaadinvaadin-accordion)
1411
[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
1512

1613
```html
@@ -28,7 +25,6 @@
2825

2926
[<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)
3027

31-
3228
## Installation
3329

3430
Install `vaadin-accordion`:
@@ -63,44 +59,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
6359

6460
`vaadin-accordion.js`
6561

66-
## Running API docs and tests in a browser
67-
68-
1. Fork the `vaadin-accordion` repository and clone it locally.
69-
70-
1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
71-
72-
1. Make sure you have [npm](https://www.npmjs.com/) installed.
73-
74-
1. When in the `vaadin-accordion` directory, run `npm install` to install dependencies.
75-
76-
1. Run `npm start`, browser will automatically open the component API documentation.
77-
78-
1. You can also open visual tests, for example:
79-
80-
- http://localhost:8000/test/visual/accordion.html
81-
82-
## Running tests from the command line
83-
84-
1. When in the `vaadin-accordion` directory, run `npm test`
85-
86-
## Debugging tests in the browser
87-
88-
1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
89-
90-
## Following the coding style
91-
92-
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.
93-
94-
95-
## Big Thanks
96-
97-
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
98-
99-
10062
## Contributing
10163

102-
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
103-
64+
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.
10465

10566
## License
10667

‎packages/vaadin-app-layout/README.md‎

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@
77
[&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).
88

99
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-app-layout)](https://www.npmjs.com/package/@vaadin/vaadin-app-layout)
10-
[![Build Status](https://travis-ci.org/vaadin/vaadin-app-layout.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-app-layout)
11-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-app-layout)
1210
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-app-layout)
13-
[![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)
1411
[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
1512

1613
```html
@@ -39,7 +36,6 @@
3936

4037
[<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)
4138

42-
4339
## Installation
4440

4541
Install `vaadin-app-layout`:
@@ -78,39 +74,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
7874
`vaadin-app-layout.js`
7975
`vaadin-drawer-toggle.js`
8076

81-
## Running API docs and tests in a browser
82-
83-
1. Fork the `vaadin-app-layout` repository and clone it locally.
84-
85-
1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
86-
87-
1. Make sure you have [npm](https://www.npmjs.com/) installed.
88-
89-
1. When in the `vaadin-app-layout` directory, run `npm install` to install dependencies.
90-
91-
1. Run `npm start`, browser will automatically open the component API documentation.
92-
93-
1. You can also open visual tests, for example:
94-
95-
- http://localhost:8000/test/visual/drawer.html
96-
97-
98-
## Running tests from the command line
99-
100-
1. When in the `vaadin-app-layout` directory, run `npm test`
101-
102-
## Debugging tests in the browser
103-
104-
1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
105-
106-
## Following the coding style
107-
108-
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.
109-
110-
11177
## Contributing
11278

113-
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
79+
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.
11480

11581
## License
11682

‎packages/vaadin-avatar/README.md‎

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@
77
[API documentation ↗](https://vaadin.com/components/vaadin-avatar/html-api)
88

99
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-avatar)](https://www.npmjs.com/package/@vaadin/vaadin-avatar)
10-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-avatar)
11-
[![Build Status](https://travis-ci.org/vaadin/vaadin-avatar.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-avatar)
1210
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-avatar)
13-
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadin-avatar-directory-urlidentifier.svg)](https://vaadin.com/directory/component/vaadinvaadin-avatar)
1411
[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
1512

1613
```html
@@ -20,16 +17,15 @@
2017
<vaadin-avatar-group max="2"></vaadin-avatar-group>
2118
<script>
2219
document.querySelector('vaadin-avatar-group').items = [
23-
{name: 'Foo Bar', colorIndex: 1},
24-
{colorIndex: 2},
25-
{name: 'Foo Bar', colorIndex: 3}
20+
{ name: 'Foo Bar', colorIndex: 1 },
21+
{ colorIndex: 2 },
22+
{ name: 'Foo Bar', colorIndex: 3 }
2623
];
2724
</script>
2825
```
2926

3027
[<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)
3128

32-
3329
## Installation
3430

3531
Install `vaadin-avatar`:
@@ -68,46 +64,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
6864
`vaadin-avatar.js`
6965
`vaadin-avatar-group.js`
7066

71-
72-
## Running API docs and tests in a browser
73-
74-
1. Fork the `vaadin-avatar` repository and clone it locally.
75-
76-
1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
77-
78-
1. Make sure you have [npm](https://www.npmjs.com/) installed.
79-
80-
1. When in the `vaadin-avatar` directory, run `npm install` to install dependencies.
81-
82-
1. Run `npm start`, browser will automatically open the component API documentation.
83-
84-
1. You can also open visual tests, for example:
85-
86-
- http://127.0.0.1:3000/test/visual/default.html
87-
88-
89-
## Running tests from the command line
90-
91-
1. When in the `vaadin-avatar` directory, run `npm test`
92-
93-
## Debugging tests in the browser
94-
95-
1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
96-
97-
## Following the coding style
98-
99-
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.
100-
101-
102-
## Big Thanks
103-
104-
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
105-
106-
10767
## Contributing
10868

109-
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
110-
69+
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.
11170

11271
## License
11372

‎packages/vaadin-board/README.md‎

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
Vaadin Board key feature is how it effectively reorders the widgets on different screen sizes, maximizing the use of space and looking stunning.
99

1010
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-board)](https://www.npmjs.com/package/@vaadin/vaadin-board)
11-
[![Build Status](https://travis-ci.org/vaadin/vaadin-board.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-board)
1211
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-board)
13-
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadinvaadin-board.svg)](https://vaadin.com/directory/component/vaadinvaadin-board)
1412
[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
1513

1614
```html
@@ -37,8 +35,7 @@ Vaadin Board key feature is how it effectively reorders the widgets on different
3735

3836
[<img src="https://raw.githubusercontent.com/vaadin/vaadin-board/master/screenshot.png" alt="Screenshot of vaadin-board">](https://vaadin.com/components/vaadin-board)
3937

40-
41-
### Installation
38+
## Installation
4239

4340
Install `vaadin-board`:
4441

@@ -52,35 +49,9 @@ Once installed, import it in your application:
5249
import '@vaadin/vaadin-board/vaadin-board.js';
5350
```
5451

55-
## Running API docs in a browser
56-
57-
1. Fork the `vaadin-board` repository and clone it locally.
58-
59-
1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
60-
61-
1. Make sure you have [npm](https://www.npmjs.com/) installed.
62-
63-
1. When in the `vaadin-board` directory, run `npm install` to install dependencies.
64-
65-
1. Run `npm start`, browser will automatically open the component API documentation.
66-
67-
## Running tests from the command line
68-
69-
1. When in the `vaadin-board` directory, run `npm test`
70-
71-
## Debugging tests in the browser
72-
73-
1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
74-
75-
## Following the coding style
76-
77-
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.
78-
79-
8052
## Contributing
8153

82-
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
83-
54+
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.
8455

8556
## License
8657

‎packages/vaadin-button/README.md‎

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,7 @@
77
[&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).
88

99
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-button)](https://www.npmjs.com/package/@vaadin/vaadin-button)
10-
[![Build Status](https://travis-ci.org/vaadin/vaadin-button.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-button)
11-
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-button)
1210
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-button)
13-
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadinvaadin-button.svg)](https://vaadin.com/directory/component/vaadinvaadin-button)
1411
[![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
1512

1613
```html
@@ -55,46 +52,9 @@ To use the Material theme, import the correspondent file from the `theme/materia
5552

5653
`vaadin-button.js`
5754

58-
## Running API docs and tests in a browser
59-
60-
1. Fork the `vaadin-button` repository and clone it locally.
61-
62-
1. Make sure you have [node.js](https://nodejs.org/) 12.x installed.
63-
64-
1. Make sure you have [npm](https://www.npmjs.com/) installed.
65-
66-
1. When in the `vaadin-button` directory, run `npm install` to install dependencies.
67-
68-
1. Run `npm start`, browser will automatically open the component API documentation.
69-
70-
1. You can also open visual tests, for example:
71-
72-
- http://127.0.0.1:3000/test/visual/default.html
73-
74-
75-
## Running tests from the command line
76-
77-
1. When in the `vaadin-button` directory, run `npm test`
78-
79-
## Debugging tests in the browser
80-
81-
1. Run `npm run debug`, then choose manual mode (M) and open the link in browser.
82-
83-
84-
## Following the coding style
85-
86-
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.
87-
88-
89-
## Big Thanks
90-
91-
Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com).
92-
93-
9455
## Contributing
9556

96-
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
97-
57+
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.
9858

9959
## License
10060

0 commit comments

Comments
 (0)