docs: Update README and add demo gifs

eea · Sep 28, 2023 · 740d843 · 740d843
1 parent 8aebeba
commit 740d843
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/DEVELOP.md b/DEVELOP.md
@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-workflow-progress/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-workflow-progress to your Volto project
 
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
@@ -50,17 +52,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        $ yarn develop
+        $ make develop
         $ yarn
 
 1.  Start backend
 
-        $ docker run -d --name plone -p 8080:8080 -e SITE=Plone -e ADDONS="eea.progress.workflow" plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone -e ADDONS="eea.progress.workflow" -e PROFILES="eea.progress.workflow:default" plone/plone-backend
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        $ docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend

diff --git a/README.md b/README.md
@@ -14,12 +14,13 @@
 [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-workflow-progress-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-workflow-progress-develop)
 [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-workflow-progress-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-workflow-progress-develop)
 
-
-[Volto](https://github.com/plone/volto) add-on
+[Volto](https://github.com/plone/volto) add-on to give Plone Content Editors an overview of Document's publication workflow progress.
 
 ## Features
 
-Demo GIF
+### Demo - Customize Workflow state's percentage via ZMI
+
+[![Workflow Progress](https://github.com/raw/eea/volto-workflow-progress/master/docs/volto-workflow-progress.gif)](https://youtu.be/MV2_23_dBkc?si=8nHRxqQmnj8yy1Cb)
 
 ## Getting started
 

diff --git a/docs/volto-workflow-progress.gif b/docs/volto-workflow-progress.gif
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-workflow-progress",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "volto-workflow-progress: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",