docs: update README

Signed-off-by: Till Sanders <mail@till-sanders.de>
tillsanders · Oct 17, 2024 · 0b3017d · 0b3017d
1 parent 90979b0
commit 0b3017d
Showing 1 changed file with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -47,24 +47,20 @@ yarn add access-key-label-polyfill
 And the import and run the install function:
 
 ```javascript
-import installAccessKeyLabelPolyfill from "access-key-label-polyfill";
-installAccessKeyLabelPolyfill();
+import "access-key-label-polyfill";
 ```
 
-Note: CJS, UMD and ESM are available, just take a look in the package.
+Note: Starting with v1.0.0, this polyfill is a native ES module.
 
 ### Browser
 
-You can also use this polyfill 'oldschool'. Simply download the demo files and add the
-`AccessKeyLabelPolyfill.umd.js` file to your body:
+You can also use this polyfill 'oldschool'. Simply download the package files and add a script tag
+to your body:
 
 ```html
 <body>
   <!-- ... -->
-  <script src="path/to/AccessKeyLabelPolyfill.umd.js"></script>
-  <script>
-    accessKeyLabelPolyfill(); // lowerCamelCase!
-  </script>
+  <script type="module" src="path/to/AccessKeyLabelPolyfill.js"></script>
 </body>
 ```
 
@@ -97,6 +93,16 @@ return the correct label. You can then use `accessKeyLabel` as expected.
 
 # Changelog
 
+## 1.0.0 – (17.10.2024)
+
+- BREAKING: Convert to native ESM module (remove UMD support)
+- BREAKING: Remove installation function (`accessKeyLabelPolyfill()`) and install automatically instead
+- Add support for Chrome on Windows
+- Update dependencies and overhaul tooling
+- Improve CI/CD
+- Move to Vite + Vitest
+- Update demo and documentation
+
 ## 0.1.1 – (10.01.2021)
 
 - Fix browser detection of Edge