@libp2p/interface-peer-discovery - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "@libp2p/interface-peer-discovery",
-  "version": "0.0.0",
-  "description": "Interfaces for JS Libp2p",
+  "version": "1.0.0",
+  "description": "Peer Discovery interface for libp2p",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interface-peer-discovery#readme",
   "repository": {
@@ -24,18 +24,2 @@ "type": "git",
   "types": "./dist/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ]
-    }
-  },
   "files": [
@@ -49,4 +33,4 @@ "src",
     ".": {
-      "import": "./dist/src/index.js",
-      "types": "./dist/src/index.d.ts"
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
     }
@@ -149,8 +133,8 @@ },
   "dependencies": {
-    "@libp2p/interface-peer-info": "^0.0.0",
-    "@libp2p/interfaces": "^2.0.3"
+    "@libp2p/interface-peer-info": "^1.0.0",
+    "@libp2p/interfaces": "^3.0.0"
   },
   "devDependencies": {
-    "aegir": "^37.0.7"
+    "aegir": "^37.2.0"
   }
 }

README.md

@@ -1,6 +0,31 @@
-interface-peer-discovery
-========================
+# @libp2p/interface-peer-discovery <!-- omit in toc -->
 
-> A test suite and interface you can use to implement a Peer Discovery module for libp2p.
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![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-interfaces.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-interfaces)
+[![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-interfaces/actions/workflows/js-test-and-release.yml)
 
+> Peer Discovery interface for libp2p
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Modules that implement the interface](#modules-that-implement-the-interface)
+- [Badge](#badge)
+- [Usage](#usage)
+  - [Node.js](#nodejs)
+- [API](#api)
+  - [`start` the service](#start-the-service)
+  - [`stop` the service](#stop-the-service)
+  - [discovering peers](#discovering-peers)
+- [License](#license)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/interface-peer-discovery
+```
+
 The primary goal of this module is to enable developers to pick and/or swap their Peer Discovery modules as they see fit for their application, without having to go through shims or compatibility issues. This module and test suite was heavily inspired by [abstract-blob-store](https://github.com/maxogden/abstract-blob-store).
@@ -79,1 +104,12 @@
 - `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`
+
+## License
+
+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>)
+
+## 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.

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9884

increased by43.91%

Number of package files

8

increased by100%

Lines of code

40

increased by110.53%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

115

increased by45.57%

Dependency changes

• + Added@chainsafe/is-ip@2.1.0(transitive)

• + Added@chainsafe/netmask@2.0.0(transitive)

• + Added@leichtgewicht/ip-codec@2.0.5(transitive)

• + Added@libp2p/interface-peer-id@2.0.2(transitive)

• + Added@libp2p/interface-peer-info@1.0.10(transitive)

• + Added@libp2p/interfaces@3.3.2(transitive)

• + Added@multiformats/dns@1.0.6(transitive)

• + Added@multiformats/multiaddr@12.3.4(transitive)

• + Added@types/dns-packet@5.6.5(transitive)

• + Added@types/node@22.13.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addeddns-packet@5.6.1(transitive)

• + Addedeventemitter3@5.0.1(transitive)

• + Addedhashlru@2.3.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedmultiformats@11.0.213.3.1(transitive)

• + Addedp-queue@8.1.0(transitive)

• + Addedp-timeout@6.1.4(transitive)

• + Addedprogress-events@1.0.1(transitive)

• + Addeduint8-varint@2.0.4(transitive)

• + Addeduint8arraylist@2.4.8(transitive)

• + Addeduint8arrays@5.1.0(transitive)

• + Addedundici-types@6.20.0(transitive)

• - Removed@fastify/busboy@2.1.1(transitive)

• - Removed@libp2p/interface-peer-id@0.0.0(transitive)

• - Removed@libp2p/interface-peer-info@0.0.0(transitive)

• - Removed@libp2p/interfaces@2.0.4(transitive)

• - Removed@multiformats/multiaddr@10.5.0(transitive)

• - Removedclone-regexp@3.0.0(transitive)

• - Removedconvert-hrtime@5.0.0(transitive)

• - Removeddebug@4.4.0(transitive)

• - Removeddns-over-http-resolver@2.1.3(transitive)

• - Removederr-code@3.0.1(transitive)

• - Removedfunction-timeout@0.1.1(transitive)

• - Removedinterface-datastore@6.1.1(transitive)

• - Removedinterface-store@2.0.2(transitive)

• - Removedip-regex@5.0.0(transitive)

• - Removedis-ip@5.0.1(transitive)

• - Removedis-regexp@3.1.0(transitive)

• - Removedit-pushable@2.0.2(transitive)

• - Removedit-stream-types@1.0.5(transitive)

• - Removedms@2.1.3(transitive)

• - Removedmultiformats@9.9.0(transitive)

• - Removednanoid@3.3.8(transitive)

• - Removednative-fetch@4.0.2(transitive)

• - Removedreceptacle@1.3.2(transitive)

• - Removedsuper-regex@0.2.0(transitive)

• - Removedtime-span@5.1.0(transitive)

• - Removeduint8arrays@3.1.1(transitive)

• - Removedundici@5.28.5(transitive)

• - Removedvarint@6.0.0(transitive)

• Updated@libp2p/interface-peer-info@^1.0.0

• Updated@libp2p/interfaces@^3.0.0