Skip to content

Commit

Permalink
Revert "update readme"
Browse files Browse the repository at this point in the history
This reverts commit e76dfed.
  • Loading branch information
DiegoCardoso committed Oct 24, 2024
1 parent 660b41d commit 923f41d
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Vaadin Charts

update readme

> ⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the [`vaadin/web-components`](https://github.com/vaadin/web-components/tree/master/packages/vaadin-charts) monorepository.
> This repository contains the source code and releases of `<vaadin-chart>` for the Vaadin versions 10 to 19.
Expand All @@ -26,18 +24,15 @@ update readme
</custom-element-demo>
```
-->

```html
<vaadin-chart type="pie">
<vaadin-chart-series
values='[
<vaadin-chart-series values='[
["Firefox", 45.0],
["IE", 26.8],
["Chrome", 12.8],
["Safari", 8.5],
["Opera", 6.2],
["Others", 0.7]]'
>
["Others", 0.7]]'>
</vaadin-chart-series>
</vaadin-chart>
```
Expand All @@ -49,6 +44,7 @@ update readme
- **Product page** https://vaadin.com/charts
- **Trial license** https://vaadin.com/pro/licenses


## Installation

Vaadin components are distributed as Bower and npm packages.
Expand All @@ -69,11 +65,12 @@ bower i vaadin/vaadin-charts --save
Once installed, import it in your application:

```html
<link rel="import" href="bower_components/vaadin-charts/vaadin-chart.html" />
<link rel="import" href="bower_components/vaadin-charts/vaadin-chart.html">
```

### Polymer 3 and ES Modules compatible version


Install `vaadin-charts`:

```sh
Expand All @@ -83,17 +80,17 @@ npm i @vaadin/vaadin-charts --save
Once installed, import it in your application:

```js
import "@vaadin/vaadin-charts/vaadin-chart.js";
import '@vaadin/vaadin-charts/vaadin-chart.js';
```

### Install License Key

After one day using Vaadin Charts in a development environment you will see a pop-up that asks you to enter the license key.
You can get your trial key from [https://vaadin.com/pro/licenses](https://vaadin.com/pro/licenses).
If the license is valid, it will be saved to the local storage of the browser and you will not see the pop-up again.

[<img src="https://raw.githubusercontent.com/vaadin/vaadin-charts/6.0-preview/screenshot.png" width="400" alt="Screenshot of vaadin-chart">](https://vaadin.com/elements/-/element/vaadin-chart)


## Running demos and tests in browser

1. Fork the `vaadin-charts` repository and clone it locally.
Expand All @@ -108,24 +105,28 @@ If the license is valid, it will be saved to the local storage of the browser an

1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:

- http://127.0.0.1:8080/components/vaadin-charts/demo
- http://127.0.0.1:8080/components/vaadin-charts/test
- http://127.0.0.1:8080/components/vaadin-charts/demo
- http://127.0.0.1:8080/components/vaadin-charts/test


## Running tests from the command line

1. When in the `vaadin-charts` directory, run `polymer test`


## 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 as well as JavaScript snippets inside `.html` files.


## Contributing

To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.


## License

_Vaadin Charts_ is distributed under the terms of
[Commercial Vaadin Add-On License version 3.0](https://vaadin.com/license/cval-3) ("CVALv3"). A copy of the license is included as `LICENSE.txt` in this software package.
[Commercial Vaadin Add-On License version 3.0](https://vaadin.com/license/cval-3) ("CVALv3"). A copy of the license is included as ```LICENSE.txt``` in this software package.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

0 comments on commit 923f41d

Please sign in to comment.