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

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "@libp2p/interface-peer-id",
-  "version": "0.0.0",
-  "description": "Interfaces for JS Libp2p",
+  "version": "0.0.1",
+  "description": "Peer Identifier 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-id#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": [
@@ -151,4 +135,4 @@ "src",
   "devDependencies": {
-    "aegir": "^37.0.7"
+    "aegir": "^37.0.17"
   }
 }

README.md

@@ -1,6 +0,23 @@
-interface-peer-id
-========================
+# @libp2p/interface-peer-id <!-- omit in toc -->
 
-> A test suite and interface you can use to implement a PeerId module for libp2p.
+[![test & maybe release](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml)
 
+> Peer Identifier 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)
+- [License](#license)
+  - [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/interface-peer-id
+```
+
 The primary goal of this module is to enable developers to implement PeerId modules. This module and test suite was heavily inspired by earlier implementation of [PeerId](https://github.com/libp2p/js-peer-id).
@@ -45,1 +62,12 @@
 ```
+
+## 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.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

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

9211

increased by54.65%

Number of package files

8

increased by100%

Lines of code

61

increased by110.34%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

73

increased by62.22%

No dependency changes