From 310dbf6870e64172c2e5bc5e610bb0514e59f3c9 Mon Sep 17 00:00:00 2001
From: Alex Potsides <alex@achingbrain.net>
Date: Sat, 7 Jan 2023 10:16:45 +0000
Subject: [PATCH] docs: publish api docs (#68)

Publish typedocs on gh-pages branch
---
 README.md    | 20 +++++++++++++++++---
 package.json |  7 ++++---
 2 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f69f270..fa24c75 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,14 @@
 # is-ipfs <!-- omit in toc -->
 
 [![codecov](https://img.shields.io/codecov/c/github/ipfs-shipyard/is-ipfs.svg?style=flat-square)](https://codecov.io/gh/ipfs-shipyard/is-ipfs)
-[![CI](https://img.shields.io/github/workflow/status/ipfs-shipyard/is-ipfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs-shipyard/is-ipfs/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs-shipyard/is-ipfs/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs-shipyard/is-ipfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > A set of utilities to help identify IPFS resources on the web
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [API](#api)
   - [Content Identifiers](#content-identifiers)
@@ -31,8 +32,9 @@
   - [Multiaddrs](#multiaddrs)
     - [`isIPFS.multiaddr(addr)`](#isipfsmultiaddraddr)
     - [`isIPFS.peerMultiaddr(addr)`](#isipfspeermultiaddraddr)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribute](#contribute)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -40,6 +42,14 @@
 $ npm i is-ipfs
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `IsIpfs` in the global namespace.
+
+```html
+<script src="https://unpkg.com/is-ipfs/dist/index.min.js"></script>
+```
+
 ## Usage
 
 ```javascript
@@ -224,6 +234,10 @@ Returns `true` if the provided `string`, [`Multiaddr`](https://github.com/multif
 
 Returns `true` if the provided `string`, [`Multiaddr`](https://github.com/multiformats/js-multiaddr) or `Uint8Array` represents a valid libp2p peer multiaddr (matching [`P2P` format from `mafmt`](https://github.com/multiformats/js-mafmt#api)) or `false` otherwise.
 
+## API Docs
+
+- <https://ipfs-shipyard.github.io/is-ipfs>
+
 ## License
 
 Licensed under either of
@@ -231,6 +245,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 94e57d4..5abe65a 100644
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -141,7 +141,8 @@
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
     "test:node": "aegir test -t node",
     "test:electron-main": "aegir test -t electron-main",
-    "release": "aegir release"
+    "release": "aegir release",
+    "docs": "aegir docs"
   },
   "dependencies": {
     "@multiformats/mafmt": "^11.0.3",
@@ -151,7 +152,7 @@
     "uint8arrays": "^4.0.2"
   },
   "devDependencies": {
-    "aegir": "^37.5.3"
+    "aegir": "^37.10.1"
   },
   "browser": {
     "fs": false