docs: Update README and DEVELOP

eea · Sep 29, 2023 · 84f9e61 · 84f9e61
1 parent 5d576f9
commit 84f9e61
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 24 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-widget-temporal-coverage/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-widget-temporal-coverage 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/)
@@ -48,18 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        yarn develop
+        make develop
         yarn
 
 1.  Start backend
 
-        docker pull plone
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone 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,11 +14,11 @@
 [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-widget-temporal-coverage-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-temporal-coverage-develop)
 [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-widget-temporal-coverage-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-temporal-coverage-develop)
 
-[Volto](https://github.com/plone/volto) add-on
+[Volto](https://github.com/plone/volto) Widget: Temporal Coverage
 
 ## Features
 
-![Widget Temporal coverage](https://raw.githubusercontent.com/eea/volto-widget-temporal-coverage/master/docs/volto-widget-temporal-coverage.gif)
+![Widget Temporal coverage](https://github.com/eea/volto-widget-temporal-coverage/raw/master/docs/volto-widget-temporal-coverage.gif)
 
 ## Getting started
 
@@ -41,25 +41,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-widget-temporal-coverage"
-  ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-widget-temporal-coverage"
+   ],
 
-  "dependencies": {
-      "@eeacms/volto-widget-temporal-coverage": "*"
-  }
-  ```
+   "dependencies": {
+       "@eeacms/volto-widget-temporal-coverage": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-  ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-widget-temporal-coverage
-  cd my-volto-project
-  ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-widget-temporal-coverage
+   cd my-volto-project
+   ```
 
 1. Install new add-ons and restart Volto: