diff --git a/README.md b/README.md index 654b989..491d5a4 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ Install via composer. composer require dnadesign/silverstripe-browser-update ``` +Rebuild your application. + +```sh +vendor/bin/sake dev/build flush=1 +``` + ## Configuration 🚧 Add the `$BrowserUpdate` function to anywhere in your page body. @@ -20,3 +26,32 @@ Add the `$BrowserUpdate` function to anywhere in your page body. ... ``` + +## Usage 🤔 + +### Creating a browser update announcement ➕ +Navigate to `/admin/browser-update-announcements` to add a new announcement. + +This page contains 'global' settings that will affect all announcements on all browsers. By default, all insecure and unsupported browsers will be notified. All full reference for the settings can be found [here](https://browser-update.org/customize.html). + +![](docs/_img/creating-a-browser-announcement.png) + +### Activating the browser update announcement 🚨 + +To activate the announcement, it must be set as active in `/admin/settings`. + +![](docs/_img/activating-the-browser-update-announcement.png) + +Now navigate to the frontend of your site, if your browser is insecure or unsupported, you should recieve a notification. + +![](docs/_img/firefox.png) + +## Targeting specific browsers 🎯 + +In order to target a specific browser you can add a 'browser version'. + +![](docs/_img/adding-a-browser-version.png) + +From here you can select a browser, select the version constraints, and customise the message that the users will recieve. If the message fields are left empty, then they will default back to the global settings. + +![](docs/_img/browser-version-settings.png) diff --git a/docs/_img/activating-the-browser-update-announcement.png b/docs/_img/activating-the-browser-update-announcement.png new file mode 100644 index 0000000..6f23429 Binary files /dev/null and b/docs/_img/activating-the-browser-update-announcement.png differ diff --git a/docs/_img/adding-a-browser-version.png b/docs/_img/adding-a-browser-version.png new file mode 100644 index 0000000..4a68fff Binary files /dev/null and b/docs/_img/adding-a-browser-version.png differ diff --git a/docs/_img/browser-version-settings.png b/docs/_img/browser-version-settings.png new file mode 100644 index 0000000..5e68707 Binary files /dev/null and b/docs/_img/browser-version-settings.png differ diff --git a/docs/_img/creating-a-browser-announcement.png b/docs/_img/creating-a-browser-announcement.png new file mode 100644 index 0000000..b568ba7 Binary files /dev/null and b/docs/_img/creating-a-browser-announcement.png differ diff --git a/docs/_img/firefox.png b/docs/_img/firefox.png new file mode 100644 index 0000000..11429bc Binary files /dev/null and b/docs/_img/firefox.png differ diff --git a/docs/_manifest_exclude b/docs/_manifest_exclude new file mode 100644 index 0000000..e69de29