From bc20defefafbe97defb64e18a7ae10527bff4ae6 Mon Sep 17 00:00:00 2001
From: Alex Potsides <alex@achingbrain.net>
Date: Fri, 16 Dec 2022 18:12:32 +0000
Subject: [PATCH] docs: publish api docs (#113)

Update project config to publish api docs
---
 .gitignore   |  7 +++----
 README.md    | 20 +++++++++++++++++---
 package.json |  7 ++++---
 3 files changed, 24 insertions(+), 10 deletions(-)

diff --git a/.gitignore b/.gitignore
index db79d1f189..1531bdf9de 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,6 @@
 node_modules
-coverage
-.nyc_output
+dist
+.docs
+.coverage
 package-lock.json
 yarn.lock
-docs
-dist
diff --git a/README.md b/README.md
index 55bf0fc645..df1eaddef5 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,18 @@
 [![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-pubsub.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-pubsub)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-pubsub/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-pubsub/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-pubsub/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-pubsub/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > libp2p pubsub base class
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribute](#contribute)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -20,6 +22,14 @@
 $ npm i @libp2p/pubsub
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pPubsub` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/pubsub/dist/index.min.js"></script>
+```
+
 ## Usage
 
 ```console
@@ -34,6 +44,10 @@ class MyPubsubImplementation extends PubSubBaseProtocol {
 }
 ```
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-pubsub>
+
 ## License
 
 Licensed under either of
@@ -41,6 +55,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 d2f899bd19..ddfa464ec1 100644
--- a/package.json
+++ b/package.json
@@ -39,7 +39,7 @@
   },
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -173,7 +173,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/crypto": "^1.0.0",
@@ -206,7 +207,7 @@
     "p-wait-for": "^5.0.0",
     "protons": "^6.0.0",
     "protons-runtime": "^4.0.1",
-    "sinon": "^14.0.0",
+    "sinon": "^15.0.1",
     "util": "^0.12.4"
   }
 }