chore: readme file updated to add instructions to use the addon

RedTurtle · Jan 15, 2025 · cc6ae57 · cc6ae57
1 parent 3ae3c65
commit cc6ae57
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,7 @@
+{
+  "workbench.colorCustomizations": {
+    "activityBar.background": "#281E75",
+    "titleBar.activeBackground": "#392AA4",
+    "titleBar.activeForeground": "#FBFBFE"
+  }
+}
diff --git a/README.md b/README.md
@@ -4,3 +4,24 @@ Block for [Volto](https://github.com/plone/volto).
 
 To be used with mrs-developer, see [Volto docs](https://docs.voltocms.com/customizing/add-ons/) for further usage informations.
 
+### How to use it
+
+1. Istall the add-on via [NPM](https://www.npmjs.com/package/@redturtle/volto-comuni-chiamo) or manually
+
+* package.json
+```
+  "addons": [
+    "@redturtle/volto-comuni-chiamo"
+  ],
+```
+```
+  "dependencies": {
+    "@redturtle/volto-comuni-chiamo": "x.x.x"
+  },
+```
+
+2. Deploy the Frontend
+3. Create a block "Blocco Comuni-Chiamo"
+4. Add the API Key in the block’s sidebar, the other options and save your changes
+5. If it work's, the block will look like this:
+![comuni-chiamo](/docs/screenshot-comuni-chiamo.png)
diff --git a/docs/screenshot-comuni-chiamo.png b/docs/screenshot-comuni-chiamo.png