Update docs

eea · Nov 9, 2020 · 832e15d · 832e15d
1 parent 5211fa0
commit 832e15d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 31 deletions.
diff --git a/DEVELOP.md b/DEVELOP.md
@@ -4,36 +4,17 @@
 
 Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
 
-1. Install `mrs.developer`
+1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
 
-        $ npm install -g mrs.developer
-
-1. Install `@plone/create-volto-app`
-
-        $ npm install -g @plone/create-volto-app
+        $ npm install -g yo
+        $ npm install -g @plone/generator-volto
+        $ npm install -g mrs-developer
 
 1. Create new volto app
 
-        $ create-volto-app my-volto-project
+        $ yo @plone/volto my-volto-project --addon @eeacms/volto-group-block
         $ cd my-volto-project
 
-1. Update `package.json` with the following information:
-
-        {
-            "scripts": {
-                "develop": "missdev --config=jsconfig.json --output=addons"
-            },
-
-            "addons": [
-                "@eeacms/volto-blocks-form",
-                "@eeacms/volto-group-block"
-            ],
-
-            "dependencies": {
-                "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.4.0",
-            }
-        }
-
 1. Add the following to `mrs.developer.json`:
 
         {
@@ -68,4 +49,4 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1. Happy hacking!
 
-        $ cd src/addons/volto-group-block/
+        $ cd src/addons/volto-group-block/
diff --git a/README.md b/README.md
@@ -12,21 +12,19 @@
 
 1. Create new volto project if you don't already have one:
     ```
-    $ npm install -g @plone/create-volto-app
-    $ create-volto-app my-volto-project
+    $ npm install -g yo @plone/generator-volto
+    $ yo @plone/volto my-volto-project --addon @eeacms/volto-group-block
     $ cd my-volto-project
     ```
 
-1. Update `package.json`:
+1. If you already have a volto project, just update `package.json`:
     ``` JSON
     "addons": [
-        "@eeacms/volto-blocks-form",
         "@eeacms/volto-group-block"
     ],
 
     "dependencies": {
-        "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.4.0",
-        "@eeacms/volto-group-block": "github:eea/volto-group-block#0.1.0"
+        "@eeacms/volto-group-block": "^1.0.0"
     }
     ```
 

diff --git a/package.json b/package.json
@@ -8,6 +8,9 @@
   "devDependencies": {
     "release-it": "*"
   },
+  "dependencies": {
+    "@eeacms/volto-blocks-form": "^1.0.0"
+  },
   "scripts": {
     "release": "release-it",
     "bootstrap": "node bootstrap"