<!-- TITLE: Brands - Magento 2 module documentation --> <!-- SUBTITLE: Author: Mateusz Bereszczuk --> # Brands Module ## Module overview Brands module allows grouping products by their brands and displaying their banner on the main page. ## Module compatibility This module is compatibile with Magento Community versions: **2.3**. ## How it works Once installed, head to **Stores > Configuration > Aurora > Brands** in order to enable the module.  In this page you can also change the attribute (**Brands** is recommended) and the amount of displayed banners. Afterwards, go to **Stores > Attributes > Product** and edit chosen attribute. In **Manage Swatch** field choose **Upload a file** option under **Swatch** and select image, which will be displayed on the main page, and then, set the name under **Admin** column.  Next, the products should be connected with previously set attribute. To do that, go to **Catalog > Products** and edit the product of interest. Find the field called Brands and choose an option defined before.  Now on the main page the uploaded image can be seen. After clicking on on it, all the associated products will be displayed.   ## Demo demo2.magecreation.com ## Installation ### Composer 1. Add repo to composer.json: ```text "repositories": [ ... { "type": "vcs", "url": "git@git.auroracreation.com:magento2/brands.git" } ... ], ``` 2. Add package to composer.json: ```text "require": { ... "aurora/brands": "*" ... }, ``` 3. In Magento root folder run commands: ```text composer update aurora/brands php bin/magento module:enable Aurora_Brands php bin/magento setup:upgrade ``` ### Manual 1. Unzip archive. 2. Upload extension files on your server to: ```text {Magento root} └── app/ └── code ``` 3. In Magento root folder run commands: ```text php bin/magento module:enable Aurora_Brands php bin/magento setup:upgrade ``` ### Thank you for your interest in our products!