From 1d8a9c24611c5b8fafa165070917e72b12967071 Mon Sep 17 00:00:00 2001 From: nileshgulia1 Date: Thu, 29 Jul 2021 13:30:38 +0530 Subject: [PATCH] update readme --- README.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 80ce56e..b56ca71 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# volto-addon-template -[![Releases](https://img.shields.io/github/v/release/eea/volto-addon-template)](https://github.com/eea/volto-addon-template/releases) -[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-addon-template%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-addon-template/job/master/display/redirect) -[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-addon-template%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-addon-template/job/develop/display/redirect) +# volto-forests-theme + +[![Releases](https://img.shields.io/github/v/release/eea/volto-forests-theme)](https://github.com/eea/volto-forests-theme/releases) +[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-forests-theme%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-forests-theme/job/master/display/redirect) +[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-forests-theme%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-forests-theme/job/develop/display/redirect) [Volto](https://github.com/plone/volto) add-on @@ -11,7 +12,7 @@ Demo GIF ## Getting started -### Try volto-addon-template with Docker +### Try volto-forests-theme with Docker 1. Get the latest Docker images @@ -21,6 +22,7 @@ Demo GIF ``` 1. Start Plone backend + ``` docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone ``` @@ -28,36 +30,36 @@ Demo GIF 1. Start Volto frontend ``` - docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-addon-template" plone/volto + docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-forests-theme" plone/volto ``` 1. Go to http://localhost:3000 -### Add volto-addon-template to your Volto project +### Add volto-forests-theme 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`: +- If you already have a volto project, just update `package.json`: - ```JSON - "addons": [ - "@eeacms/volto-addon-template" - ], + ```JSON + "addons": [ + "@eeacms/volto-forests-theme" + ], - "dependencies": { - "@eeacms/volto-addon-template": "^1.0.0" - } - ``` + "dependencies": { + "@eeacms/volto-forests-theme": "^0.1.0" + } + ``` -* If not, create one: +- If not, create one: - ``` - npm install -g yo @plone/generator-volto - yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template - cd my-volto-project - ``` + ``` + npm install -g yo @plone/generator-volto + yo @plone/volto my-volto-project --addon @eeacms/volto-forests-theme + cd my-volto-project + ``` 1. Install new add-ons and restart Volto: @@ -72,14 +74,14 @@ Demo GIF ## How to contribute -See [DEVELOP.md](https://github.com/eea/volto-addon-template/blob/master/DEVELOP.md). +See [DEVELOP.md](https://github.com/eea/volto-forests-theme/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](https://github.com/eea/volto-addon-template/blob/master/LICENSE.md) for details. +See [LICENSE.md](https://github.com/eea/volto-forests-theme/blob/master/LICENSE.md) for details. ## Funding