📚 docs: Update.

Author: make-github-pseudonymous-again

.esdoc.json

@@ -50,6 +50,12 @@
           "./doc/scripts/header.js"
         ]
       }
+    },
+    {
+      "name": "esdoc-ecmascript-proposal-plugin",
+      "option": {
+        "all": true
+      }
     }
   ]
 }

.github/workflows/gh-pages.yml

@@ -17,7 +17,7 @@ jobs:
         run: npm run build-gh-pages
 
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@4.1.1
+        uses: JamesIves/github-pages-deploy-action@v4.4.0
         with:
           branch: gh-pages
           folder: gh-pages

README.md

@@ -4,7 +4,8 @@
 Lempel-Ziv lossless data compression algorithms for JavaScript.
 See [docs](https://compression-algorithm.github.io/lempel-ziv/index.html).
 
-> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
+> :warning: Depending on your environment, the code may require
+> `regeneratorRuntime` to be defined, for instance by importing
 > [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
 
 ```js

doc/manual/usage.md

@@ -1,18 +1,19 @@
 # Usage
 
-> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
+> :warning: Depending on your environment, the code may require
+> `regeneratorRuntime` to be defined, for instance by importing
 > [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
 
 First, require the polyfill at the entry point of your application
 ```js
-await import( 'regenerator-runtime/runtime.js' );
+await import('regenerator-runtime/runtime.js');
 // or
-import 'regenerator-runtime/runtime.js' ;
+import 'regenerator-runtime/runtime.js';
 ```
 
 Then, import the library where needed
 ```js
-const lempelziv = await import( '@compression-algorithm/lempel-ziv' ) ;
+const {lz78} = await import('@compression-algorithm/lempel-ziv');
 // or
-import * as lempelziv from '@compression-algorithm/lempel-ziv' ;
+import {lz78} from '@compression-algorithm/lempel-ziv';
 ```

doc/scripts/header.js

@@ -10,7 +10,7 @@ const domReady = function (callback) {
 domReady(() => {
 	const projectname = document.createElement('a');
 	projectname.classList.add('project-name');
-	projectname.text = 'compression-algorithm/lempel-ziv';
+	projectname.text = '@compression-algorithm/lempel-ziv';
 	projectname.href = './index.html';
 
 	const header = document.querySelector('header');

package.json

@@ -6,8 +6,8 @@
   "author": "make-github-pseudonymous-again",
   "homepage": "https://compression-algorithm.github.io/lempel-ziv",
   "repository": {
-    "type": "git",
-    "url": "https://github.com/compression-algorithm/lempel-ziv"
+    "url": "https://github.com/compression-algorithm/lempel-ziv",
+    "type": "git"
   },
   "bugs": {
     "url": "https://github.com/compression-algorithm/lempel-ziv/issues"