@libp2p/pubsub 8.0.8 → 8.0.9-051154dd
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +5 -30
- package/dist/index.min.js +6 -6
- package/dist/src/index.d.ts +14 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +25 -2
- package/dist/src/index.js.map +1 -1
- package/package.json +8 -8
- package/src/index.ts +29 -2
- package/dist/typedoc-urls.json +0 -30
package/README.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
# @libp2p/pubsub <!-- omit in toc -->
|
|
2
|
-
|
|
3
1
|
[](http://libp2p.io/)
|
|
4
2
|
[](https://discuss.libp2p.io)
|
|
5
3
|
[](https://codecov.io/gh/libp2p/js-libp2p)
|
|
@@ -7,22 +5,13 @@
|
|
|
7
5
|
|
|
8
6
|
> libp2p pubsub base class
|
|
9
7
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
- [Install](#install)
|
|
13
|
-
- [Browser `<script>` tag](#browser-script-tag)
|
|
14
|
-
- [Usage](#usage)
|
|
15
|
-
- [API Docs](#api-docs)
|
|
16
|
-
- [License](#license)
|
|
17
|
-
- [Contribution](#contribution)
|
|
18
|
-
|
|
19
|
-
## Install
|
|
8
|
+
# Install
|
|
20
9
|
|
|
21
10
|
```console
|
|
22
11
|
$ npm i @libp2p/pubsub
|
|
23
12
|
```
|
|
24
13
|
|
|
25
|
-
|
|
14
|
+
## Browser `<script>` tag
|
|
26
15
|
|
|
27
16
|
Loading this module through a script tag will make it's exports available as `Libp2pPubsub` in the global namespace.
|
|
28
17
|
|
|
@@ -30,31 +19,17 @@ Loading this module through a script tag will make it's exports available as `Li
|
|
|
30
19
|
<script src="https://unpkg.com/@libp2p/pubsub/dist/index.min.js"></script>
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
```console
|
|
36
|
-
npm i @libp2p/pubsub
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
```javascript
|
|
40
|
-
import { PubSubBaseProtocol } from '@libp2p/pubsub'
|
|
41
|
-
|
|
42
|
-
class MyPubsubImplementation extends PubSubBaseProtocol {
|
|
43
|
-
// .. extra methods here
|
|
44
|
-
}
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## API Docs
|
|
22
|
+
# API Docs
|
|
48
23
|
|
|
49
24
|
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_pubsub.html>
|
|
50
25
|
|
|
51
|
-
|
|
26
|
+
# License
|
|
52
27
|
|
|
53
28
|
Licensed under either of
|
|
54
29
|
|
|
55
30
|
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
56
31
|
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
|
57
32
|
|
|
58
|
-
|
|
33
|
+
# Contribution
|
|
59
34
|
|
|
60
35
|
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.
|