Merge pull request #59 from swup/chore/release

Prepare v5 release

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [5.0.0] - 2024-04-15
+
+This is a complete overhaul of the plugin, based on extensive feedback and testing in screen
+readers. Some breaking changes have been made to improve the defaults. If you haven't customized the
+plugin options, it's safe to upgrade, otherwise consult the readme.
+
+- Rethink announcements: use assertive live region and announce after a delay (@ScoobyDid)
+- Focus `body` on navigation instead of `main`
+- Only use `h1` for announcements by default, ignore `h2`
+- Disable animations by default if users prefer reduced motion
+- Correctly exclude `inert` elements from autofocus
+- Tested in VoiceOver, JAWS and NVDA
+
 ## [4.5.1] - 2024-04-02
 
 - Fix the type signature of `AnnouncementTranslations`
@@ -54,6 +67,7 @@
 
 - Initial release
 
+[5.0.0]: https://github.com/swup/a11y-plugin/releases/tag/5.0.0
 [4.5.1]: https://github.com/swup/a11y-plugin/releases/tag/4.5.1
 [4.5.0]: https://github.com/swup/a11y-plugin/releases/tag/4.5.0
 [4.4.2]: https://github.com/swup/a11y-plugin/releases/tag/4.4.2

README.md

@@ -28,7 +28,7 @@ import SwupA11yPlugin from '@swup/a11y-plugin';
 Or include the minified production file from a CDN:
 
 ```html
-<script src="https://unpkg.com/@swup/a11y-plugin@4"></script>
+<script src="https://unpkg.com/@swup/a11y-plugin@5"></script>
 ```
 
 ## Usage

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swup/a11y-plugin",
   "amdName": "SwupA11yPlugin",
-  "version": "4.5.1",
+  "version": "5.0.0",
   "description": "A swup plugin for enhanced accessibility",
   "type": "module",
   "source": "src/index.ts",