Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document the addon installation #18

Merged
merged 1 commit into from
Oct 29, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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).