Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
simonsymhoven committed Sep 18, 2022
1 parent 4ca6665 commit 6fe17b5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,14 @@

## Introduction

This plugin reports data from a nested data file as pie-charts, trend-charts and data tables.
This plugin visualizes user-specific content from various file formats, such as json, yaml, xml or csv.
The UI displays information in various graphs and tables, like pie-charts, history charts and data tables.

## Usage

User-specific files such as Json files are the starting point, containing the content to be displayed.
You need to provide an `id` and a list of `items`. Each item in this list can have a further list of `items`.
However, an item on the lowest level must then contain a `result`. This `result` can be any combination of key, value pairs.
If an item has `items`, the `result` will be computed automatically for this parent item.
Please make sure you use a unique identifier for the `id`!

Expand Down
3 changes: 2 additions & 1 deletion src/main/resources/index.jelly
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?jelly escape-by-default='true'?>
<div>
This plugin reports data from nested json as pie-charts, trend-charts and data tables.
This plugin visualizes user-specific content from various file formats, such as json, yaml, xml or csv.
The UI displays information in various graphs and tables, like pie-charts, history charts and data tables.
</div>

0 comments on commit 6fe17b5

Please sign in to comment.