From 718a85aaf663a6b90f8a344e91f72a77c406ba06 Mon Sep 17 00:00:00 2001
From: Regis Philibert <login@regisphilibert.com>
Date: Thu, 23 Dec 2021 20:42:55 +0000
Subject: [PATCH] Featured image detection refactoring:

---
 README.md |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
index 3d9ed80..6a64a70 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,10 @@
 
 For any page or post you can add a featured image by including the local path in front matter (see content in the `exampleSite/content/_readme.md` file for examples): `featured_image: '/images/gohugo-default-sample-hero-image.jpg'`
 
+#### Featured image as Page Resources
+If user is using [Page Resources](https://gohugo.io/content-management/page-resources/), the theme will try and match the `featured_image` from with a page resource of type `image` and use its relative permalink. If no `featured_image` is set, the theme will look for a Page Resource of type `image` whose filepath incudes either `cover` or `feature` 
+
+#### Other hero settings
 If you would like to hide the header text on the featured image on a page, set `omit_header_text` to `true`. See `exampleSite/content/contact.md` for an example.
 
 You don't need an image though. The default background color is black, but you can change the color, by changing the default color class in the config.toml file. Choose a background color from any on the [Tachyons](http://tachyons.io/docs/themes/skins/) library site, and preface it with "bg-"

--
Gitblit v1.10.0