Merge pull request #91 from eea/develop

Release

Author: avoinea

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [5.2.4](https://github.com/eea/volto-block-style/compare/5.2.3...5.2.4) - 29 September 2023
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`235ce19`](https://github.com/eea/volto-block-style/commit/235ce1995257e6ba8a4c945e2f5fffcc0dd44ee7)]
+- docs: Update README and DEVELOP [Alin Voinea - [`6424344`](https://github.com/eea/volto-block-style/commit/642434458757c1887b863a7fa5e7b0ffcc2c8593)]
+
 ### [5.2.3](https://github.com/eea/volto-block-style/compare/5.2.2...5.2.3) - 25 September 2023
 
 #### :bug: Bug Fixes

DEVELOP.md

@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-block-style/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-block-style 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

README.md

@@ -31,26 +31,12 @@ block types that you want to enable. By default it is enabled for all blocks.
 
 ### Try volto-block-style with Docker
 
-1. Get the latest Docker images
+      git clone https://github.com/eea/volto-block-style.git
+      cd volto-block-style
+      make
+      make start
 
-   ```
-   docker pull plone
-   docker pull plone/volto
-   ```
-
-1. Start Plone backend
-
-   ```
-   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
-   ```
-
-1. Start Volto frontend
-
-   ```
-   docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-block-style" plone/volto
-   ```
-
-1. Go to http://localhost:3000
+Go to http://localhost:3000
 
 ### Add volto-block-style to your Volto project
 
@@ -62,25 +48,25 @@ block types that you want to enable. By default it is enabled for all blocks.
 
 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-block-style"
-  ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-block-style"
+   ],
 
-  "dependencies": {
-      "@eeacms/volto-block-style": "^1.0.0"
-  }
-  ```
+   "dependencies": {
+       "@eeacms/volto-block-style": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-  ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --addon @eeacms/volto-block-style
-  cd my-volto-project
-  ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-block-style
+   cd my-volto-project
+   ```
 
 1. Install new add-ons and restart Volto:
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-block-style",
-  "version": "5.2.3",
+  "version": "5.2.4",
   "description": "volto-block-style: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",