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).