Skip to content

Commit

Permalink
📝 chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Cambis committed Jul 23, 2024
1 parent bcabbc7 commit 6e384dc
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -20,3 +26,32 @@ Add the `$BrowserUpdate` function to anywhere in your page body.
...
</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)
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/_img/adding-a-browser-version.png
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/_img/browser-version-settings.png
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/_img/creating-a-browser-announcement.png
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/_img/firefox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added docs/_manifest_exclude
Empty file.

0 comments on commit 6e384dc

Please # to comment.