Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added screenshots #4

Merged
merged 1 commit into from
Jun 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/superglue-cms.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/superglue-frontend.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 17 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down