@libp2p/kad-dht 6.1.0 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,13 +3,14 @@
3
3
  [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
4
4
  [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
5
5
  [![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)
6
- [![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)
6
+ [![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)
7
7
 
8
8
  > JavaScript implementation of the Kad-DHT for libp2p
9
9
 
10
10
  ## Table of contents <!-- omit in toc -->
11
11
 
12
12
  - [Install](#install)
13
+ - [Browser `<script>` tag](#browser-script-tag)
13
14
  - [Use in Node.js](#use-in-nodejs)
14
15
  - [API](#api)
15
16
  - [Custom secondary DHT in libp2p](#custom-secondary-dht-in-libp2p)
@@ -18,6 +19,7 @@
18
19
  - [Peer Discovery](#peer-discovery)
19
20
  - [Spec](#spec)
20
21
  - [Contribute](#contribute)
22
+ - [API Docs](#api-docs)
21
23
  - [License](#license)
22
24
  - [Contribute](#contribute-1)
23
25
 
@@ -27,6 +29,14 @@
27
29
  $ npm i @libp2p/kad-dht
28
30
  ```
29
31
 
32
+ ### Browser `<script>` tag
33
+
34
+ Loading this module through a script tag will make it's exports available as `Libp2pKadDht` in the global namespace.
35
+
36
+ ```html
37
+ <script src="https://unpkg.com/@libp2p/kad-dht/dist/index.min.js"></script>
38
+ ```
39
+
30
40
  ```sh
31
41
  > npm i @libp2p/kad-dht
32
42
  ```
@@ -86,6 +96,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
86
96
 
87
97
  [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
88
98
 
99
+ ## API Docs
100
+
101
+ - <https://libp2p.github.io/js-libp2p-kad-dht>
102
+
89
103
  ## License
90
104
 
91
105
  Licensed under either of