Skip to content

Commit

Permalink
docs: add demo gif - refs #253277
Browse files Browse the repository at this point in the history
* docs: add demo gif - refs #253277

* docs: update README with the correct path to the gif

* add absolute path for gif - master branch

---------

Co-authored-by: Claudia Ifrim <ifrim.claudia@gmail.com>
  • Loading branch information
ana-oprea and claudiaifrim committed Aug 30, 2023
1 parent 8954bbb commit 3a5ebbc
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@
[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-statistic-block-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-statistic-block-develop)
[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-statistic-block-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-statistic-block-develop)


[Volto](https://github.com/plone/volto) add-on

## Features

https://eea.github.io/volto-kitkat-frontend/?path=/story/components-statistic--default

![Statistic Block](https://github.com/raw/eea/volto-statistic-block/master/docs/volto-statistic-block.gif)

## Getting started

### Try volto-statistic-block with Docker
Expand All @@ -42,25 +43,25 @@ Go to http://localhost:3000

1. Start Volto frontend

* If you already have a volto project, just update `package.json`:
- If you already have a volto project, just update `package.json`:

```JSON
"addons": [
"@eeacms/volto-statistic-block"
],
```JSON
"addons": [
"@eeacms/volto-statistic-block"
],

"dependencies": {
"@eeacms/volto-statistic-block": "^1.0.0"
}
```
"dependencies": {
"@eeacms/volto-statistic-block": "^1.0.0"
}
```

* If not, create one:
- If not, create one:

```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @eeacms/volto-statistic-block
cd my-volto-project
```
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @eeacms/volto-statistic-block
cd my-volto-project
```

1. Install new add-ons and restart Volto:

Expand Down
Binary file added docs/volto-statistic-block.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3a5ebbc

Please sign in to comment.