Update docs

eea · Mar 29, 2021 · 6dde4e0 · 6dde4e0
1 parent 02ba2ac
commit 6dde4e0
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 31 deletions.
diff --git a/DEVELOP.md b/DEVELOP.md
@@ -6,19 +6,12 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
 
-        $ npm install -g yo
-        $ npm install -g @plone/generator-volto
-        $ npm install -g mrs-developer
+        npm install -g yo @plone/generator-volto mrs-developer
 
 1.  Create new volto app
 
-        $ yo @plone/volto \
-             my-dev-project \
-             --addon @eeacms/volto-group-block \
-             --workspace src/addons/volto-group-block \
-             --no-interactive \
-             --skip-install
-        $ cd my-dev-project
+        yo @plone/volto my-dev-project --addon @eeacms/volto-group-block --skip-install
+        cd my-dev-project
 
 1.  Add the following to `mrs.developer.json`:
 
@@ -33,25 +26,25 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        $ yarn develop
-        $ yarn
+        yarn develop
+        yarn
 
 1.  Start backend
 
-        $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
+        docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        $ docker logs -f plone
+        docker logs -f plone
 
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend
 
-        $ yarn start
+        yarn start
 
 1.  Go to http://localhost:3000
 
 1.  Happy hacking!
 
-        $ cd src/addons/volto-group-block/
+        cd src/addons/volto-group-block/
diff --git a/README.md b/README.md
@@ -9,39 +9,63 @@
 
 ![Group blocks and restrict available blocks](https://github.com/eea/volto-group-block/raw/docs/docs/volto-group-block.gif)
 
-## Getting started
+### Try volto-group-block with Docker
 
-1. Create new volto project if you don't already have one:
+1. Get the latest Docker images
 
    ```
-   $ npm install -g yo @plone/generator-volto
-   $ yo @plone/volto \
-        my-volto-project \
-        --addon @eeacms/volto-group-block \
-        --no-interactive \
-        --skip-install
-
-   $ cd my-volto-project
-   $ yarn add -W @eeacms/volto-group-block
+   docker pull plone
+   docker pull plone/volto
    ```
 
-1. If you already have a volto project, just update `package.json`:
+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-group-block" plone/volto
+   ```
+
+1. Go to http://localhost:3000
+
+1. Login with **admin:admin**
+
+1. Create a new **Page** and add a new **Section (Group)** block.
+
+### Add volto-group-block to your Volto project
+
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
+
+1. Start Volto frontend
+
+* If you already have a volto project, just update `package.json`:
 
    ```JSON
    "addons": [
        "@eeacms/volto-group-block"
    ],
 
    "dependencies": {
-       "@eeacms/volto-group-block": "^2.0.0"
+       "@eeacms/volto-group-block": "^4.0.0"
    }
    ```
 
+* If not, create one:
+
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --addon @eeacms/volto-group-block
+   cd my-volto-project
+   ```
+
 1. Install new add-ons and restart Volto:
 
    ```
-   $ yarn
-   $ yarn start
+   yarn
+   yarn start
    ```
 
 1. Go to http://localhost:3000