diff --git a/docs/images/superglue-cms.gif b/docs/images/superglue-cms.gif new file mode 100644 index 0000000..376030b Binary files /dev/null and b/docs/images/superglue-cms.gif differ diff --git a/docs/images/superglue-frontend.png b/docs/images/superglue-frontend.png new file mode 100644 index 0000000..34abc79 Binary files /dev/null and b/docs/images/superglue-frontend.png differ diff --git a/readme.md b/readme.md index 5626819..6b5b342 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,23 @@ $ composer require silverstripe/superglue ## Docs -Working on the docs. You can find an [overview on the SilverStripe blog](http://www.silverstripe.org/blog/superglue-your-pages)! +You can find an [overview on the SilverStripe blog](http://www.silverstripe.org/blog/superglue-your-pages)! + +## Example Usage + +An example usage for Superglue would be if you have a list of featured news & events. By default, you may want to display the latest 4 items. However, if there's a special news aritcle or event you may want to pin this, giving it a higher priority than the standard news articles and then display the rest of the list afterwards. Here's an example of what that looks like with Superglue. + +Select your pinned items in the CMS: + +![A screen recording of the CMS showing the content author clicking a "pin" button in a list of unpinned items, and the item moving to the "pinned" list of items above](docs/images/superglue-cms.gif "CMS recording of superglue") + +The pinned items appear first, followed by a default list of non-pinned items. + +![A screen shot of the website showing the two selected pinned items appearing first and a default list of items apearing afterwards](docs/images/superglue-frontend.png "Example usage of latest news & events") + + + + ## Tests