docs: publish api docs (#411)

Updates project config to publish api docs

Author: achingbrain

.gitignore

@@ -1,45 +1,8 @@
-**/node_modules/
-**/*.log
-test/repo-tests*
-**/bundle.js
-docs
-
-# 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
-.nyc_output

README.md

@@ -3,13 +3,14 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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-kad-dht.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht)
-[![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-kad-dht/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-kad-dht/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-kad-dht/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > JavaScript implementation of the Kad-DHT for libp2p
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
   - [Use in Node.js](#use-in-nodejs)
 - [API](#api)
   - [Custom secondary DHT in libp2p](#custom-secondary-dht-in-libp2p)
@@ -18,6 +19,7 @@
   - [Peer Discovery](#peer-discovery)
 - [Spec](#spec)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -27,6 +29,14 @@
 $ npm i @libp2p/kad-dht
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pKadDht` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/kad-dht/dist/index.min.js"></script>
+```
+
 ```sh
 > npm i @libp2p/kad-dht
 ```
@@ -86,6 +96,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-kad-dht>
+
 ## License
 
 Licensed under either of

package.json

@@ -22,7 +22,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -138,7 +138,8 @@
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
     "dep-check": "aegir dep-check",
-    "release": "aegir release"
+    "release": "aegir release",
+    "docs": "aegir docs"
   },
   "dependencies": {
     "@libp2p/crypto": "^1.0.4",
@@ -196,7 +197,7 @@
     "@types/lodash.range": "^3.2.6",
     "@types/varint": "^6.0.0",
     "@types/which": "^2.0.1",
-    "aegir": "^37.3.0",
+    "aegir": "^37.7.7",
     "datastore-level": "^9.0.0",
     "delay": "^5.0.0",
     "execa": "^6.0.0",
@@ -214,5 +215,10 @@
   },
   "browser": {
     "./dist/src/routing-table/generated-prefix-list.js": "./dist/src/routing-table/generated-prefix-list-browser.js"
+  },
+  "typedocs": {
+    "KadDHTComponents": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTComponents.html",
+    "KadDHTInit": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTInit.html",
+    "kadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/functions/kadDHT.html"
   }
 }