From ee401715bd47c686fd69bbb6a7db4fc617f29f68 Mon Sep 17 00:00:00 2001
From: Mikel Larreategi <mlarreategi@codesyntax.com>
Date: Thu, 28 Oct 2021 20:48:23 +0200
Subject: [PATCH] document the addon installation

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 684ece5..8d2261d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,31 @@
 # volto-listingadvanced-variation
+
 Volto addon to add an additional variation to the default listing block with advanced features
 
-Auto
+This add-on adds a fully customizable variation to the default listing block. It adds the following features:
+
+- Select to show the image of the item or not
+- Select the position of the image in the item card
+- Select the size of the card (to build mosaic-like listings)
+- An option to select to show the publication date
+- Select the number of columns in which the content will be shown
+
+Installation:
+
+- Add this package to your Volto's package.json dependencies
+
+```javascript
+  "dependencies": {
+    "@codesyntax/volto-listingadvanced-variation": "0.5.0",
+  },
+```
+
+- Add it to the addon's list
+
+```javascript
+  "addons": [
+    "volto-form-block"
+  ],
+```
+
+If you have any issue with this addon, just [add a new issue in GitHub](https://github.com/codesyntax/volto-listingadvanced-block).