docs: update project config (#323)

Updates readmes to link to module docs directly, fixes build badges.
libp2p · Dec 16, 2022 · 0fc6a08 · 0fc6a08
1 parent 1160f7d
commit 0fc6a08
Show file tree

Hide file tree

Showing 30 changed files with 59 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Contains test suites and interfaces you can use to implement the various components of libp2p
 

diff --git a/packages/interface-address-manager/README.md b/packages/interface-address-manager/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Address Manager interface for libp2p
 
@@ -29,7 +29,7 @@ import type { AddressManager } from '@libp2p/interfaces-address-manager'
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_address_manager.html>
 
 ## License
 

diff --git a/packages/interface-compliance-tests/README.md b/packages/interface-compliance-tests/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for JS libp2p interfaces
 
@@ -27,7 +27,7 @@ Each [interface](https://npmjs.org/packages/@libp2p/interfaces) has its document
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_compliance_tests.html>
 
 ## License
 

diff --git a/packages/interface-connection-compliance-tests/README.md b/packages/interface-connection-compliance-tests/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for implementations of the libp2p Connection interface
 
@@ -47,7 +47,7 @@ describe('your connection', () => {
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_compliance_tests.html>
 
 ## License
 

diff --git a/packages/interface-connection-encrypter-compliance-tests/README.md b/packages/interface-connection-encrypter-compliance-tests/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for implementations of the libp2p Connection Encrypter interface
 
@@ -40,7 +40,7 @@ tests({
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_encrypter_compliance_tests.html>
 
 ## License
 

diff --git a/packages/interface-connection-encrypter/README.md b/packages/interface-connection-encrypter/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Connection Encrypter interface for libp2p
 
@@ -96,7 +96,7 @@ console.log(error.code === UnexpectedPeerError.code) // true
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_encrypter.html>
 
 ## License
 

diff --git a/packages/interface-connection-manager/README.md b/packages/interface-connection-manager/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Connection Manager interface for libp2p
 
@@ -29,7 +29,7 @@ import type { ConnectionManager } from '@libp2p/interface-connection-manager'
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_manager.html>
 
 ## License
 

diff --git a/packages/interface-connection/README.md b/packages/interface-connection/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Connection interface for libp2p
 
@@ -301,7 +301,7 @@ This property contains an array of tags associated with the connection. New tags
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection.html>
 
 ## License
 

diff --git a/packages/interface-content-routing/README.md b/packages/interface-content-routing/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Content routing interface for libp2p
 
@@ -86,7 +86,7 @@ It returns a promise that is resolved on the success of the operation.
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_content_routing.html>
 
 ## License
 

diff --git a/packages/interface-dht/README.md b/packages/interface-dht/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > DHT interface for libp2p
 
@@ -22,7 +22,7 @@ $ npm i @libp2p/interface-dht
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_dht.html>
 
 ## License
 

diff --git a/packages/interface-keychain/README.md b/packages/interface-keychain/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Keychain interface for libp2p
 
@@ -86,7 +86,7 @@ It returns a promise that is resolved on the success of the operation.
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_keychain.html>
 
 ## License
 

diff --git a/packages/interface-keys/README.md b/packages/interface-keys/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Keys interface for libp2p
 
@@ -42,7 +42,7 @@ tests({
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_keys.html>
 
 ## License
 

diff --git a/packages/interface-metrics/README.md b/packages/interface-metrics/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Metrics interface for libp2p
 
@@ -27,7 +27,7 @@ $ npm i @libp2p/interface-metrics
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_metrics.html>
 
 ## License
 

diff --git a/packages/interface-mocks/README.md b/packages/interface-mocks/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Mock implementations of several libp2p interfaces
 
@@ -36,7 +36,7 @@ Each [interface](../interfaces) has its documentation on how to use the complian
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_mocks.html>
 
 ## License
 

diff --git a/packages/interface-peer-discovery-compliance-tests/README.md b/packages/interface-peer-discovery-compliance-tests/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for implementations of the libp2p Peer Discovery interface
 
@@ -41,7 +41,7 @@ describe('your peer discovery implementation', () => {
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_peer_discovery_compliance_tests.html>
 
 ## License
 

diff --git a/packages/interface-peer-discovery/README.md b/packages/interface-peer-discovery/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Peer Discovery interface for libp2p
 
@@ -104,7 +104,7 @@ Every time a peer is discovered by a discovery service, it emits a `peer` event
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_peer_discovery.html>
 
 ## License
 

diff --git a/packages/interface-peer-id/README.md b/packages/interface-peer-id/README.md
@@ -3,7 +3,7 @@
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![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)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Peer Identifier interface for libp2p
 
@@ -66,7 +66,7 @@ describe('your peer id', () => {
 
 ## API Docs
 
-- <https://libp2p.github.io/js-libp2p-interfaces>
+- <https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_peer_id.html>
 
 ## License