From 73de145ea19bc05cb2144c5dedd0dad943bcbf5f Mon Sep 17 00:00:00 2001 From: James Cocker Date: Fri, 13 Mar 2020 10:48:33 +0000 Subject: [PATCH] Readme updates --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 52f90ae..0df358f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Basic Image Galleries Module +# Basic Image Gallery Page (& Multiple Gallery Holder Page) ## Introduction @@ -6,18 +6,19 @@ Provides basic image gallery functionality to a SilverStripe site. Designed to provide a simple, fool-proof way for users to add image galleries to their website. -This module has been designed to have just the minimum required features, to avoid bloat, but can be easily extended to add new fields if required. - ## Maintainer Contact ## * James Cocker (ssmodulesgithub@pswd.biz) ## Requirements * Silverstripe 4.1+ - * Use the 1.0 branch for SilverStripe 3.1 support ## Installation Instructions -1. Place the contents of this repository in a directory named *basic-galleries* at the root of your SilverStripe install. +1. Install: +```` +composer require purplespider/purplespider/basic-galleries ^1 +```` + 2. Visit yoursite.com/dev/build to rebuild the database. 3. Log in the CMS, and create a new Photo Gallery Holder page. 4. You can then create Photo Gallery Pages underneath this holder. @@ -25,9 +26,7 @@ This module has been designed to have just the minimum required features, to avo ## Config -The Extension can be applied to any page type to enable the gallery functionality. - -You can also customise the CMS tab that the gallery appears on, as well as the title of the gallery displayed in the CMS: +You can customise the CMS tab that the gallery appears on, as well as the title of the gallery displayed in the CMS: ```` HomePage: