Skip to content

Commit

Permalink
chore: update project
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain committed Sep 11, 2024
1 parent 7cfc09a commit 788b110
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ updates:
schedule:
interval: daily
time: "10:00"
open-pull-requests-limit: 10
open-pull-requests-limit: 20
commit-message:
prefix: "deps"
prefix-development: "deps(dev)"
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @libp2p/pubsub-peer-discovery

[![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-peer-discovery.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-pubsub-peer-discovery)
Expand All @@ -7,6 +9,21 @@
# About

<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->

When the discovery module is started by libp2p it subscribes to the discovery pubsub topic(s)

It will immediately broadcast your peer data via pubsub and repeat the broadcast on the configured `interval`
Expand Down Expand Up @@ -104,7 +121,7 @@ $ npm i @libp2p/pubsub-peer-discovery

## Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `Libp2pPubsubPeerDiscovery` in the global namespace.
Loading this module through a script tag will make its exports available as `Libp2pPubsubPeerDiscovery` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/pubsub-peer-discovery/dist/index.min.js"></script>
Expand All @@ -118,8 +135,8 @@ Loading this module through a script tag will make it's exports available as `Li

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>)
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-pubsub-peer-discovery/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-pubsub-peer-discovery/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribution

Expand Down

0 comments on commit 788b110

Please sign in to comment.