Skip to content

Commit 3a26f66

Browse files
committed
docs: Update README and DEVELOP
1 parent e76a014 commit 3a26f66

File tree

2 files changed

+14
-17
lines changed

2 files changed

+14
-17
lines changed

DEVELOP.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@
1616

1717
1. Go to http://localhost:3000
1818

19-
1. Happy hacking!
19+
1. Initialize git hooks
2020

2121
```Bash
22-
cd src/addons/volto-widget-toggle/
22+
yarn prepare
2323
```
2424

25+
1. Happy hacking!
26+
2527
### Or add @eeacms/volto-widget-toggle to your Volto project
2628

2729
Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
2830

2931
1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
3032

31-
$ npm install -g yo
32-
$ npm install -g @plone/generator-volto
33-
$ npm install -g mrs-developer
33+
npm install -g yo @plone/generator-volto mrs-developer
3434

3535
1. Create new volto app
3636

37-
$ yo @plone/volto my-volto-project --addon @eeacms/volto-widget-toggle
38-
$ cd my-volto-project
37+
yo @plone/volto my-volto-project --addon @eeacms/volto-widget-toggle --skip-install
38+
cd my-volto-project
3939

4040
1. Add the following to `mrs.developer.json`:
4141

@@ -50,28 +50,26 @@ Before starting make sure your development environment is properly set. See [Vol
5050

5151
1. Install
5252

53-
$ yarn develop
54-
$ yarn
53+
make develop
54+
yarn
5555

5656
1. Start backend
5757

58-
$ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
58+
docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
5959

6060
...wait for backend to setup and start - `Ready to handle requests`:
6161

62-
$ docker logs -f plone
63-
6462
...you can also check http://localhost:8080/Plone
6563

6664
1. Start frontend
6765

68-
$ yarn start
66+
yarn start
6967

7068
1. Go to http://localhost:3000
7169

7270
1. Happy hacking!
7371

74-
$ cd src/addons/volto-widget-toggle/
72+
cd src/addons/volto-widget-toggle/
7573

7674
## Cypress
7775

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@
1414
[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-widget-toggle-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle-develop)
1515
[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-widget-toggle-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle-develop)
1616

17-
18-
[Volto](https://github.com/plone/volto) add-on
17+
[Volto](https://github.com/plone/volto) add-on: Replace any checkbox with a nice toggle button within edit forms
1918

2019
## Features
2120

22-
Demo GIF
21+
![Toogle Checkboxes](https://raw.githubusercontent.com/eea/volto-widget-toggle/docs/docs/volto-widget-toggle.gif)
2322

2423
## Getting started
2524

0 commit comments

Comments
 (0)