From eb4c67d7edbb8f9162ece3bdb1d2cd1b49224b64 Mon Sep 17 00:00:00 2001
From: achingbrain <alex@achingbrain.net>
Date: Thu, 22 Dec 2022 13:12:00 +0000
Subject: [PATCH] docs: generate typedocs

Updates project config to generate typedocs.
---
 .gitignore   |  6 +++---
 README.md    | 20 +++++++++++++++++---
 package.json | 13 +++++++------
 3 files changed, 27 insertions(+), 12 deletions(-)

diff --git a/.gitignore b/.gitignore
index 82a994f..56422ce 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 node_modules
-coverage
-.nyc_output
+.coverage
 package-lock.json
 dist
-.clinic
\ No newline at end of file
+.clinic
+.docs
diff --git a/README.md b/README.md
index 84894d8..3b10e6e 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,14 @@
 # it-length-prefixed <!-- omit in toc -->
 
 [![codecov](https://img.shields.io/codecov/c/github/alanshaw/it-length-prefixed.svg?style=flat-square)](https://codecov.io/gh/alanshaw/it-length-prefixed)
-[![CI](https://img.shields.io/github/workflow/status/alanshaw/it-length-prefixed/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/alanshaw/it-length-prefixed/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/alanshaw/it-length-prefixed/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/alanshaw/it-length-prefixed/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Streaming length prefixed buffers with async iterables
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [API](#api)
   - [`encode([opts])`](#encodeopts)
@@ -15,8 +16,9 @@
   - [`decode([opts])`](#decodeopts)
   - [`decode.fromReader(reader, [opts])`](#decodefromreaderreader-opts)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribute](#contribute-1)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -24,6 +26,14 @@
 $ npm i it-length-prefixed
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `ItLengthPrefixed` in the global namespace.
+
+```html
+<script src="https://unpkg.com/it-length-prefixed/dist/index.min.js"></script>
+```
+
 ## Usage
 
 ```js
@@ -124,6 +134,10 @@ Returns a [transform](https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef5
 
 PRs and issues gladly accepted! Check out the [issues](https://github.com/alanshaw/it-length-prefixed/issues).
 
+## API Docs
+
+- <https://alanshaw.github.io/it-length-prefixed>
+
 ## License
 
 Licensed under either of
@@ -131,6 +145,6 @@ Licensed under either of
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
diff --git a/package.json b/package.json
index 61abe2a..4da94b5 100644
--- a/package.json
+++ b/package.json
@@ -44,7 +44,7 @@
   },
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -168,7 +168,8 @@
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
     "test:node": "aegir test -t node --cov",
     "test:electron-main": "aegir test -t electron-main",
-    "release": "aegir release"
+    "release": "aegir release",
+    "docs": "aegir docs"
   },
   "dependencies": {
     "err-code": "^3.0.1",
@@ -181,11 +182,11 @@
     "@types/varint": "^6.0.0",
     "aegir": "^37.4.5",
     "iso-random-stream": "^2.0.0",
-    "it-all": "^1.0.6",
+    "it-all": "^2.0.0",
     "it-block": "^6.0.0",
-    "it-drain": "^1.0.5",
-    "it-foreach": "^0.1.1",
-    "it-map": "^1.0.6",
+    "it-drain": "^2.0.0",
+    "it-foreach": "^1.0.0",
+    "it-map": "^2.0.0",
     "it-pipe": "^2.0.2",
     "it-pushable": "^3.0.0",
     "it-reader": "^6.0.1",