@libp2p/interface-keychain - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "@libp2p/interface-keychain",
-  "version": "0.0.0",
-  "description": "Interfaces for JS Libp2p",
+  "version": "1.0.0",
+  "description": "Keychain 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-keychain#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"
     }
@@ -152,4 +136,4 @@ },
   "devDependencies": {
-    "aegir": "^37.0.7"
+    "aegir": "^37.0.17"
   }
 }

README.md

@@ -1,8 +0,26 @@
-interface-content-routing
-=====================
+# @libp2p/interface-keychain <!-- omit in toc -->
 
-**WIP: This module is not yet implemented**
+[![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)
 
-> A test suite and interface you can use to implement a Content Routing module for libp2p.
+> Keychain interface for libp2p
 
+## Table of contents <!-- omit in toc -->
+
+- - [Install](#install)
+- [Modules that implement the interface](#modules-that-implement-the-interface)
+- [Badge](#badge)
+- [How to use the battery of tests](#how-to-use-the-battery-of-tests)
+  - [Node.js](#nodejs)
+- [API](#api)
+  - - [findProviders](#findproviders)
+    - [provide](#provide)
+  - [License](#license)
+    - [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/interface-keychain
+```
+
 The primary goal of this module is to enable developers to pick and swap their Content Routing module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer.
@@ -40,2 +58,3 @@
 **Parameters**
+
 - [CID](https://github.com/multiformats/js-cid)
@@ -56,2 +75,3 @@
 **Parameters**
+
 - [CID](https://github.com/multiformats/js-cid)
@@ -64,1 +84,12 @@
 `Promise<void>`
+
+## 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

8816

increased by45.45%

Number of package files

8

increased by100%

Lines of code

45

increased by104.55%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

93

increased by50%

No dependency changes