From 4b75f67558f55e153429e45dd8f7f5f62352ba46 Mon Sep 17 00:00:00 2001 From: Joseph Wynn Date: Fri, 17 Jul 2020 12:31:13 +1200 Subject: [PATCH] Make it clear that the plugin does nothing without a `sizes` config --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f762cb7..bc240a3 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,15 @@ For more advanced templates, see the [**Templates**](#templates) section below. ### 3. Configure the plugin -You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. The minimum required configuration is a `template` path: +You **must** have a `responsive_image` block in your `_config.yml` for this plugin to work. The minimum required configuration is a `template` path. You should also have a `sizes` configuration or the plugin will not do anything. ```yaml responsive_image: template: _includes/responsive-image.html + sizes: + - width: 320 + - width: 480 + - width: 800 ``` For a list of all the available configuration options, see the [**All configuration options**](#all-configuration-options) section below.