From b0ff4832751ef74eb012d5058d04e8b087894fe8 Mon Sep 17 00:00:00 2001
From: Alex Potsides <alex@achingbrain.net>
Date: Fri, 16 Dec 2022 09:53:29 +0000
Subject: [PATCH] docs: publish typedoc api docs (#152)

Updates project config to publish typedocs
---
 .gitignore   | 44 ++++----------------------------------------
 README.md    | 17 +++++++++++++++--
 package.json |  7 ++++---
 3 files changed, 23 insertions(+), 45 deletions(-)

diff --git a/.gitignore b/.gitignore
index 4db4e02..910f633 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,44 +1,8 @@
-docs
-**/node_modules/
-**/*.log
-test/repo-tests*
-**/bundle.js
-
-# Logs
-logs
-*.log
-
-coverage
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
-
-lib
+build
 dist
-test/test-data/go-ipfs-repo/LOCK
-test/test-data/go-ipfs-repo/LOG
-test/test-data/go-ipfs-repo/LOG.old
-
-# while testing npm5
+.docs
+.coverage
+node_modules
 package-lock.json
 yarn.lock
diff --git a/README.md b/README.md
index 3a81dd7..df90fe1 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,19 @@
 # @libp2p/bootstrap <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-bootstrap)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-bootstrap/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-bootstrap/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-bootstrap/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Node.js IPFS Implementation of the railing process of a Node through a bootstrap peer list
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -22,6 +23,14 @@
 $ npm i @libp2p/bootstrap
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pBootstrap` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/bootstrap/dist/index.min.js"></script>
+```
+
 ## Usage
 
 The configured bootstrap peers will be discovered after the configured timeout. This will ensure
@@ -86,6 +95,10 @@ The libp2p implementation in JavaScript is a work in progress. As such, there ar
 - Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
 - **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-bootstrap>
+
 ## License
 
 Licensed under either of
diff --git a/package.json b/package.json
index 242d349..779bb57 100644
--- a/package.json
+++ b/package.json
@@ -22,7 +22,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -135,7 +135,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": {
     "@libp2p/interface-peer-discovery": "^1.0.1",
@@ -152,7 +153,7 @@
     "@libp2p/interface-peer-id": "^1.0.4",
     "@libp2p/peer-id-factory": "^1.0.18",
     "@libp2p/peer-store": "^5.0.0",
-    "aegir": "^37.5.3",
+    "aegir": "^37.7.5",
     "datastore-core": "^8.0.1",
     "delay": "^5.0.0"
   }