chore: update readmes (#233)

Author: achingbrain

README.md

@@ -1,30 +1,58 @@
-# JS libp2p Interfaces
+# js-libp2p-interfaces <!-- omit in toc -->
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![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)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/ci?label=ci&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions?query=branch%3Amaster+workflow%3Aci+)
+[![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)
 
 > Contains test suites and interfaces you can use to implement the various components of libp2p
 
-## Structure
+## Table of contents <!-- omit in toc -->
 
-* [`/packages/libp2p-connection`](./packages/libp2p-connection) An implementation of the Connection interface
-* [`/packages/libp2p-interfaces`](./packages/libp2p-interfaces) The interface definitions of various libp2p components
-* [`/packages/libp2p-interfaces-compliance-tests`](./packages/libp2p-interfaces-compliance-tests) Tests to ensure adherence of an implementation to the spec
-* [`/packages/libp2p-pubsub`](./packages/libp2p-pubsub) An implementation of the Pubsub interface
-* [`/packages/libp2p-topology`](./packages/libp2p-topology) An implementation of the Topology interface
+- [Structure](#structure)
+- [License](#license)
+- [Contribution](#contribution)
 
-## Contribute
+## Structure
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-interfaces/issues)!
+- [`/packages/interface-address-manager`](./packages/interface-address-manager) Address Manager interface for libp2p
+- [`/packages/interface-compliance-tests`](./packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces
+- [`/packages/interface-connection`](./packages/interface-connection) Connection interface for libp2p
+- [`/packages/interface-connection-compliance-tests`](./packages/interface-connection-compliance-tests) Compliance tests for implementations of the libp2p Connection interface
+- [`/packages/interface-connection-encrypter`](./packages/interface-connection-encrypter) Connection Encrypter interface for libp2p
+- [`/packages/interface-connection-encrypter-compliance-tests`](./packages/interface-connection-encrypter-compliance-tests) Compliance tests for implementations of the libp2p Connection Encrypter interface
+- [`/packages/interface-connection-manager`](./packages/interface-connection-manager) Connection Manager interface for libp2p
+- [`/packages/interface-content-routing`](./packages/interface-content-routing) Content routing interface for libp2p
+- [`/packages/interface-dht`](./packages/interface-dht) DHT interface for libp2p
+- [`/packages/interface-keychain`](./packages/interface-keychain) Keychain interface for libp2p
+- [`/packages/interface-keys`](./packages/interface-keys) Keys interface for libp2p
+- [`/packages/interface-metrics`](./packages/interface-metrics) Metrics interface for libp2p
+- [`/packages/interface-mocks`](./packages/interface-mocks) Mock implementations of several libp2p interfaces
+- [`/packages/interface-peer-discovery`](./packages/interface-peer-discovery) Peer Discovery interface for libp2p
+- [`/packages/interface-peer-discovery-compliance-tests`](./packages/interface-peer-discovery-compliance-tests) Compliance tests for implementations of the libp2p Peer Discovery interface
+- [`/packages/interface-peer-id`](./packages/interface-peer-id) Peer Identifier interface for libp2p
+- [`/packages/interface-peer-info`](./packages/interface-peer-info) Peer Info interface for libp2p
+- [`/packages/interface-peer-routing`](./packages/interface-peer-routing) Peer Routing interface for libp2p
+- [`/packages/interface-peer-store`](./packages/interface-peer-store) Peer Store interface for libp2p
+- [`/packages/interface-pubsub`](./packages/interface-pubsub) PubSub interface for libp2p
+- [`/packages/interface-pubsub-compliance-tests`](./packages/interface-pubsub-compliance-tests) Compliance tests for implementations of the libp2p PubSub interface
+- [`/packages/interface-record`](./packages/interface-record) Record interface for libp2p
+- [`/packages/interface-record-compliance-tests`](./packages/interface-record-compliance-tests) Compliance tests for implementations of the libp2p Record interface
+- [`/packages/interface-registrar`](./packages/interface-registrar) Registrar interface for libp2p
+- [`/packages/interface-stream-muxer`](./packages/interface-stream-muxer) Stream Muxer interface for libp2p
+- [`/packages/interface-stream-muxer-compliance-tests`](./packages/interface-stream-muxer-compliance-tests) Compliance tests for implementations of the libp2p Stream Muxer interface
+- [`/packages/interface-transport`](./packages/interface-transport) Transport interface for libp2p
+- [`/packages/interface-transport-compliance-tests`](./packages/interface-transport-compliance-tests) Compliance tests for implementations of the libp2p Transport interface
+- [`/packages/interfaces`](./packages/interfaces) Common code shared by the various libp2p interfaces
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+## License
 
-[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
+Licensed under either of
 
-## License
+- 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
 
-[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs
+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.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "js-libp2p-interfaces",
   "version": "1.0.0",
-  "description": "Interfaces for JS Libp2p",
+  "description": "Contains test suites and interfaces you can use to implement the various components of libp2p",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-interfaces#readme",
   "repository": {

packages/interface-address-manager/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-address-manager <!-- 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)
+[![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)
 
 > Address Manager interface for libp2p
 
@@ -9,7 +13,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -30,6 +34,6 @@ 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
+## 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.

packages/interface-address-manager/package.json

@@ -128,7 +128,7 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interfaces": "^2.0.0",
+    "@libp2p/interfaces": "^3.0.0",
     "@multiformats/multiaddr": "^10.2.0"
   },
   "devDependencies": {

packages/interface-compliance-tests/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-compliance-tests <!-- 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)
+[![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)
 
 > Compliance tests for JS libp2p interfaces
 
@@ -9,7 +13,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -28,6 +32,6 @@ 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
+## 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.

packages/interface-connection-compliance-tests/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-connection-compliance-tests <!-- 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)
+[![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)
 
 > Compliance tests for implementations of the libp2p Connection interface
 
@@ -9,7 +13,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -48,6 +52,6 @@ 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
+## 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.

packages/interface-connection-compliance-tests/package.json

@@ -128,7 +128,7 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-compliance-tests": "^2.0.0",
+    "@libp2p/interface-compliance-tests": "^3.0.0",
     "@libp2p/interface-connection": "~0.0.0",
     "aegir": "^37.0.17",
     "sinon": "^14.0.0"

packages/interface-connection-encrypter-compliance-tests/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-connection-encrypter-compliance-tests <!-- 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)
+[![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)
 
 > Compliance tests for implementations of the libp2p Connection Encrypter interface
 
@@ -9,7 +13,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -41,6 +45,6 @@ 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
+## 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.

packages/interface-connection-encrypter-compliance-tests/package.json

@@ -128,10 +128,10 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-compliance-tests": "^2.0.0",
+    "@libp2p/interface-compliance-tests": "^3.0.0",
     "@libp2p/interface-connection": "~0.0.0",
-    "@libp2p/interface-connection-encrypter": "~0.0.0",
-    "@libp2p/interface-peer-id": "~0.0.0",
+    "@libp2p/interface-connection-encrypter": "^1.0.0",
+    "@libp2p/interface-peer-id": "^1.0.0",
     "@libp2p/peer-id-factory": "^1.0.12",
     "@multiformats/multiaddr": "^10.2.0",
     "aegir": "^37.0.17",

packages/interface-connection-encrypter/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-connection-encrypter <!-- 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)
+[![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)
 
 > Connection Encrypter interface for libp2p
 
@@ -13,7 +17,7 @@
 - [Crypto Errors](#crypto-errors)
   - [Error Types](#error-types)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -101,6 +105,6 @@ 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
+## 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.

packages/interface-connection-encrypter/package.json

@@ -148,7 +148,7 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-peer-id": "~0.0.0",
+    "@libp2p/interface-peer-id": "^1.0.0",
     "it-stream-types": "^1.0.4"
   },
   "devDependencies": {

packages/interface-connection-manager/README.md

@@ -1,6 +1,10 @@
 # @libp2p/interface-connection-manager <!-- 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)
+[![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)
 
 > Connection Manager interface for libp2p
 
@@ -9,7 +13,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
 
 ## Install
 
@@ -30,6 +34,6 @@ 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
+## 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.

packages/interface-connection-manager/package.json

@@ -129,8 +129,8 @@
   },
   "dependencies": {
     "@libp2p/interface-connection": "~0.0.0",
-    "@libp2p/interface-peer-id": "~0.0.0",
-    "@libp2p/interfaces": "^2.0.0"
+    "@libp2p/interface-peer-id": "^1.0.0",
+    "@libp2p/interfaces": "^3.0.0"
   },
   "devDependencies": {
     "aegir": "^37.0.17"