diff --git a/DEVELOP.md b/DEVELOP.md index 7f5c4bd..63e5d7f 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -20,13 +20,25 @@ Before starting make sure your development environment is properly set. See [Vol 1. Update `package.json` with the following information: { + "private": true, + + "workspaces": [ + "src/addons/volto-columns-block" + ], + "scripts": { "develop": "missdev --config=jsconfig.json --output=addons" }, "addons": [ + "@eeacms/volto-blocks-form", "@eeacms/volto-columns-block" ], + + "dependencies": { + "@plone/volto": "8.2.0", + "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.5.0" + }, } 1. Add the following to `mrs.developer.json`: @@ -35,7 +47,7 @@ Before starting make sure your development environment is properly set. See [Vol "volto-columns-block": { "url": "https://github.com/eea/volto-columns-block.git", "package": "@eeacms/volto-columns-block", - "branch": "develop", + "branch": "master", "path": "src" } } @@ -47,7 +59,7 @@ Before starting make sure your development environment is properly set. See [Vol 1. Start backend - $ docker run -d --name plone -p 8080:8080 -e SITE=Plone -e VERSIONS="plone.restapi=7.0.0a5" -e ADDONS="kitconcept.volto" plone:5 + $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone:5 ...wait for backend to setup and start - `Ready to handle requests`: diff --git a/README.md b/README.md index 315797b..3596280 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,10 @@ This package gives you a block with columns. Each column is its own separate blocks container. -Note: for the moment this relies on the https://github.com/plone/volto/pull/1826 PR. - -Note: this is a work in progress, UX will be improved. - ### -![first alpha screenshot](screenshot-a0.png) +![Columns Layout](https://github.com/raw/eea/volto-columns-block/docs/docs/layout.png) +![Columns Example](https://github.com/raw/eea/volto-columns-block/docs/docs/columns.png) ## Getting started @@ -28,11 +25,13 @@ Note: this is a work in progress, UX will be improved. 1. Update `package.json`: ``` JSON "addons": [ + "@eeacms/volto-blocks-form", "@eeacms/volto-columns-block" ], "dependencies": { - "@eeacms/volto-columns-block": "github:eea/volto-columns-block#0.1.0" + "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.5.0", + "@eeacms/volto-columns-block": "github:eea/volto-columns-block#0.2.0" } ``` @@ -48,14 +47,14 @@ Note: this is a work in progress, UX will be improved. ## How to contribute -See [DEVELOP.md](DEVELOP.md). +See [DEVELOP.md](https://github.com/eea/volto-columns-block/blob/master/DEVELOP.md). ## Copyright and license The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved. -See [LICENSE.md](LICENSE.md) for details. +See [LICENSE.md](https://github.com/eea/volto-columns-block/blob/master/LICENSE.md) for details. ## Funding diff --git a/package.json b/package.json index b247002..a717f13 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@eeacms/volto-columns-block", - "version": "0.1.0", + "version": "0.2.0", "description": "volto-columns-block: Volto add-on", "main": "src/index.js", "repository": "https://github.com/eea/volto-columns-block", diff --git a/screenshot-a0.png b/screenshot-a0.png deleted file mode 100644 index 1d03e73..0000000 Binary files a/screenshot-a0.png and /dev/null differ