Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise English README for clarity and structure #945

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revise English README for clarity and structure #945

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions docs/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
## README

# Introduction
## Introduction

When using [echarts](http://echarts.baidu.com) to generate charts, we often need to do cumbersome data scheme conversion, modify complex configuration items, v-charts precisely to solve this. v-charts is based on Vue2.x and echarts, just need to provide a friendly data scheme and set simple configuration items, you can easily generate common charts.
Creating charts with [ECharts](http://echarts.baidu.com) often involves complex data transformations and intricate configuration settings. vcharts simplifies this process. Built on Vue 2.x and ECharts, vcharts allows you to generate graphical charts easily by providing a user-friendly data structure and minimal configuration.

## Installation

### npm

Install v-charts and ECharts by using the following command:

```
npm i v-charts echarts -S
```
Expand All @@ -18,14 +23,14 @@ npm i v-charts echarts -S
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/v-charts/lib/style.min.css">
```

> when using bmap or amap need to add additional modules
> If you're using BMap or AMap charts, additional modules are required:
> <br>`<script src="https://cdn.jsdelivr.net/npm/echarts-amap/dist/echarts-amap.min.js"></script>`
> <br>`<script src="https://cdn.jsdelivr.net/npm/echarts/dist/extension/bmap.min.js"></script>`


#### Example
#### Example #1

[online demo](https://jsfiddle.net/vue_echarts/hc4xhyva)
[Here is a basic example of using v-charts to create a line chart](https://jsfiddle.net/vue_echarts/hc4xhyva)

```html
<!DOCTYPE html>
Expand Down Expand Up @@ -65,9 +70,9 @@ npm i v-charts echarts -S
</html>
```

#### Use a single chart component
#### Example #2

[online demo](https://jsfiddle.net/vue_echarts/6h15xnxx)
[Here's an example of how to use a specific chart component](https://jsfiddle.net/vue_echarts/6h15xnxx)

```html
<!DOCTYPE html>
Expand Down Expand Up @@ -107,4 +112,4 @@ npm i v-charts echarts -S
</script>
</body>
</html>
```
```