docs: publish api docs (#201)

Updates project config to publish api docs
libp2p · Dec 16, 2022 · 722b03a · 722b03a
1 parent eb6e2cd
commit 722b03a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,8 @@
 node_modules
-package-lock.json
-coverage
-.nyc_output
-docs
+build
 dist
-.coverage
+.docs
+.coverage
+node_modules
+package-lock.json
+yarn.lock
diff --git a/README.md b/README.md
@@ -3,19 +3,21 @@
 [![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-websockets.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-websockets)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-websockets/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-websockets/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Usage](#usage)
   - [Constructor properties](#constructor-properties)
 - [Libp2p Usage Example](#libp2p-usage-example)
 - [API](#api)
   - [Transport](#transport)
   - [Connection](#connection)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute)
 
@@ -25,6 +27,14 @@
 $ npm i @libp2p/websockets
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pWebsockets` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/websockets/dist/index.min.js"></script>
+```
+
 [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
 
@@ -53,7 +63,7 @@ await node.dial('/ip4/127.0.0.1/tcp/9090/ws')
 | Name     | Type                                                                                                                       | Description                                                            | Default                                                                 |
 | -------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------- |
 | upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED**                                                            |
-| filter   | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>`                                                                       | override transport addresses filter                                    | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+{WS, WSS} multiaddrs |
+| filter   | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>`                                                                       | override transport addresses filter                                    | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+[WS, WSS] multiaddrs |
 
 You can create your own address filters for this transports, or rely in the filters [provided](./src/filters.js).
 
@@ -104,6 +114,10 @@ For more information see [libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-tran
 
 [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-websockets>
+
 ## License
 
 Licensed under either of

diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
   },
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -155,7 +155,8 @@
     "test:firefox-webworker": "aegir test -t webworker -f ./dist/test/browser.js -- --browser firefox",
     "test:node": "aegir test -t node -f ./dist/test/node.js --cov",
     "test:electron-main": "aegir test -t electron-main -f ./dist/test/node.js --cov",
-    "release": "aegir release"
+    "release": "aegir release",
+    "docs": "aegir docs"
   },
   "dependencies": {
     "@libp2p/interface-connection": "^3.0.2",