# Installation
Clone the repository into `~/public_html/plugins/FeaturedProducts/`:

```bash
git clone https://YOUR_BITBUCKET_ACCOUNT@bitbucket.org/mtcmedia/core-plugins-featuredproducts.git ~/public_html/plugins/FeaturedProducts/ && rm -rf ~/public_html/plugins/FeaturedProducts/.git
```

# Usage
Include the twig function where you want to display your featured products with NUMBER being the maximum amount to show.

```bash
{{ featured_products(NUMBER) }}
```

# Edit the Template
Should you wish to tailor the template make a copy of the shop/item/featured_items.twig file and place it in the root of your sites/YOUR_SITE/templates folder... it will then override the plugin version of the template.

# Admin area
A featured products link with icon is automatically created for you as part of the install script.  This can be triggered for direct installation on live either by using the install file directly or by visiting /plugins/FeaturedProducts/admin/ which will trigger this.