From 76cc42f5bbefc78738771ad44c2769592a88f22b Mon Sep 17 00:00:00 2001 From: Mikhail Volkov <47795110+mikhail-vl@users.noreply.github.com> Date: Sat, 9 Sep 2023 15:33:48 -0400 Subject: [PATCH] Updated README and documentation (#214) * Updated README and documentation * Update CHANGELOG.md --- CHANGELOG.md | 6 ++++++ README.md | 59 +++++++++++++++++++++++----------------------------- package.json | 2 +- 3 files changed, 33 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2bbfc10..6591bf5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 5.2.0 (IN PROGRESS) + +### Features / Enhancements + +- Updated README and documentation (#214) + ## 5.1.0 (2023-08-11) ### Features / Enhancements diff --git a/README.md b/README.md index 99e4bd3..5078e65 100644 --- a/README.md +++ b/README.md @@ -11,24 +11,24 @@ ## Introduction -The Apache ECharts plugin is a visualization panel for Grafana that allows you to incorporate the popular Apache ECharts library into your Grafana dashboard. +The Apache ECharts Panel plugin is a data visualization extension for Grafana that allows you to integrate charts and graphs from the popular Apache ECharts library into your Grafana dashboard. -[Apache ECharts](https://echarts.apache.org/en/index.html) is a free, powerful charting and visualization library with statistical capabilities. It is written in pure JavaScript and based on zrender. +[Apache ECharts](https://echarts.apache.org/en/index.html) is a powerful and versatile data visualization library providing a wide range of chart types including statistical capabilities. It is written in pure JavaScript and based on [zrender](http://ecomfe.github.io/zrender/), a lightweight graphic library for chart rendering. [![Apache ECharts panel for Grafana | Explore possibilities](https://raw.githubusercontent.com/volkovlabs/volkovlabs-echarts-panel/main/img/overview.png)](https://youtu.be/S3PiL1p1v5U) -Apache ECharts visualization panel offers an easy way of adding intuitive, interactive, and highly customizable charts into your Grafana dashboard. +The Apache ECharts plugin offers an easy way of adding intuitive, interactive, and highly customizable charts into your Grafana dashboard. -### Requirements +## Requirements -- **Grafana 9** and **Grafana 10** are required for major version 5. -- **Grafana 8.5** and **Grafana 9** are required for major versions 3 and 4. +- Apache ECharts Panel 5.X requires **Grafana 9** or **Grafana 10**. +- Apache ECharts Panel 3.X and 4.X require **Grafana 8.5** or **Grafana 9**. ## Getting Started -Apache ECharts visualization panel can be installed from the [Grafana Catalog](https://grafana.com/grafana/plugins/volkovlabs-echarts-panel/) or utilizing the Grafana command line tool. +You can install Apache ECharts Panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/volkovlabs-echarts-panel/) or using the Grafana command line tool. -For the latter, use the following command. +For the latter, please use the following command. ```bash grafana-cli plugins install volkovlabs-echarts-panel @@ -36,23 +36,22 @@ grafana-cli plugins install volkovlabs-echarts-panel ## Highlights -- Provides Monaco Code Editor for: +- Provides [Monaco Code Editor](https://microsoft.github.io/monaco-editor/) for: - Working with Grafana data frames (JavaScript). - - Updating chart configurations in JSON format. - - Custom theme configuration. -- Supports variables and location service to make Charts interactive. -- Based on the ECharts 5.4.3. -- Supports Light and Dark themes synchronized with Grafana Theme. + - Updating chart configurations in the JSON format. + - Customizing theme configurations. +- Supports variables and [locationService](https://grafana.com/docs/grafana/latest/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables/#set-a-variable-from-your-plugin) to make charts interactive. +- Based on [Apache ECharts 5.4.3](https://github.com/apache/echarts/releases/tag/5.4.3). +- Supports light and dark themes adjusted to the Grafana theme. - Supports SVG and Canvas renderers. - Includes USA and World GeoJSON maps. Additional maps can be loaded dynamically. -- Includes [Liquid Fill Chart](https://github.com/ecomfe/echarts-liquidfill), which is usually used to represent data in percentage. -- Includes [WordCloud Chart](https://github.com/ecomfe/echarts-wordcloud), which is usually used to represent data WordCloud format (word frequency). -- Includes [ECharts-GL](https://github.com/ecomfe/echarts-gl), which provides 3D plots, globe visualization, and WebGL acceleration. +- Includes [Liquid Fill Chart](https://github.com/ecomfe/echarts-liquidfill) to represent data in percentage. +- Includes [ECharts-GL](https://github.com/ecomfe/echarts-gl) proving 3D plots, globe visualization, and WebGL acceleration. - Includes [ecStat](https://github.com/ecomfe/echarts-stat), a statistical and data mining tool. -- Supports Code Editor suggestions for Parameters and variables. -- Supports Baidu, Gaode, and Google Maps using API. Requires to provide access key. -- Supports real-time data updates using streaming Data Sources and Grafana Live. -- Has 100+ ready-as-is examples at [echarts.volkovlabs.io](https://echarts.volkovlabs.io). +- Supports Code Editor suggestions for parameters and variables. +- Supports Baidu, Gaode, and Google Maps using API. Requires the provision of the access key. +- Supports real-time data updates using streaming data sources and Grafana Live. +- Provides 100+ ready-to-use examples at [echarts.volkovlabs.io](https://echarts.volkovlabs.io). [![Examples](https://github.com/VolkovLabs/volkovlabs-echarts-panel/raw/main/src/img/examples.png)](https://echarts.volkovlabs.io) @@ -64,23 +63,17 @@ grafana-cli plugins install volkovlabs-echarts-panel | [Examples](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/examples/) | Explains how to get started with ECharts Examples. | | [Features](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/features/) | Demonstrates panel features. | | [Maps](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/maps/) | Demonstrates how to work with different maps. | -| [Tutorials](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/tutorials/) | Tutorials for Apache ECharts panel. | +| [Tutorials](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/tutorials/) | Tutorials for Apache ECharts Panel. | | [Release Notes](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/release/) | Stay up to date with the latest features and updates. | -## Tutorial - -Three plugins that make Grafana complete. Dynamic Text, Data Manipulation, and Apache ECharts are all you need to create functional real-world web applications. - -[![Magic JavaScript trio for Grafana | Dynamic Text, Data Manipulation and Apache ECharts plugins](https://raw.githubusercontent.com/volkovlabs/volkovlabs-echarts-panel/main/img/magic-trio.png)](https://youtu.be/wPr4gZYzUVA) - ## Feedback -We love to hear from you. There are various ways to get in touch with us: +We're looking forward to hearing from you. You can use different ways to get in touch with us. -- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/volkovlabs/volkovlabs-echarts-panel/issues/new/choose). -- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and add a comment. -- Sponsor our open-source plugins for Grafana with [GitHub Sponsor](https://github.com/sponsors/VolkovLabs). -- Star the repository to show your support. +- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/volkovlabs-echarts-panel/issues/new/choose). +- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and leave your comments. +- Sponsor our open-source plugins for Grafana at [GitHub Sponsor](https://github.com/sponsors/VolkovLabs). +- Support our project by starring the repository. ## License diff --git a/package.json b/package.json index 8cff762..dc1876b 100644 --- a/package.json +++ b/package.json @@ -78,5 +78,5 @@ "test:ci": "jest --maxWorkers 4 --coverage", "upgrade": "npm upgrade --save" }, - "version": "5.1.0" + "version": "5.2.0" }