@libp2p/interface-record - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "@libp2p/interface-record",
-  "version": "0.0.0",
-  "description": "Compliance tests for implementations of the libp2p connection interface",
+  "version": "1.0.0",
+  "description": "Record interface for libp2p",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interface-compliance-tests#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interface-record#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"
     }
@@ -146,13 +130,6 @@ },
     "build": "aegir build",
-    "test": "aegir test",
-    "test:chrome": "aegir test -t browser --cov",
-    "test:chrome-webworker": "aegir test -t webworker",
-    "test:firefox": "aegir test -t browser -- --browser firefox",
-    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
-    "test:node": "aegir test -t node --cov",
-    "test:electron-main": "aegir test -t electron-main",
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-peer-id": "^0.0.0"
+    "@libp2p/interface-peer-id": "~0.0.0"
   },
@@ -159,0 +136,0 @@ "devDependencies": {

README.md

@@ -1,4 +0,24 @@
-interface-record
-==================
+# @libp2p/interface-record <!-- omit in toc -->
 
+[![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)
+
+> Record interface for libp2p
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [Create Record](#create-record)
+- [API](#api)
+  - [marshal](#marshal)
+  - [equals](#equals)
+- [License](#license)
+  - [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/interface-record
+```
+
 A libp2p node needs to store data in a public location (e.g. a DHT), or rely on potentially untrustworthy intermediaries to relay information. Libp2p provides an all-purpose data container called **envelope**, which includes a signature of the data, so that it its authenticity can be verified.
@@ -88,5 +108,18 @@
 **Parameters**
+
 - other is a `Record` to compare with the current instance.
 
 **Returns**
+
 - `other is Record`
+
+## 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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

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

9428

increased by29.17%

Number of package files

8

increased by166.67%

Lines of code

63

increased by103.23%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

125

increased by35.87%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

License quality

80

decreased by-20%

Dependency changes

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

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

• Updated@libp2p/interface-peer-id@~0.0.0