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

Comparing version 1.0.19 to 1.0.20

package.json

 {
   "name": "@libp2p/peer-id-factory",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "Create PeerId instances",
@@ -25,3 +25,3 @@ "license": "Apache-2.0 OR MIT",
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
@@ -156,6 +156,9 @@ "!**/*.tsbuildinfo"
   "devDependencies": {
-    "aegir": "^37.0.7",
+    "aegir": "^37.7.5",
     "protons": "^6.0.0",
     "util": "^0.12.4"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }

README.md

 # @libp2p/peer-id-factory <!-- omit in toc -->
 
 [![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-peer-id.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-peer-id)
-[![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-peer-id/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-peer-id/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
@@ -14,6 +13,8 @@ > Create PeerId instances
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Description](#description)
 - [Example](#example)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute)
 
@@ -26,2 +27,10 @@ ## Install
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pPeerIdFactory` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/peer-id-factory/dist/index.min.js"></script>
+```
+
 ## Description
@@ -48,2 +57,6 @@
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-peer-id/modules/_libp2p_peer_id_factory.html>
+
 ## License
@@ -56,4 +69,4 @@
 
-## Contribution
+## Contribute
 
 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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Improved metrics

Total package byte prevSize

261935

increased by999%

Number of package files

16

increased by14.29%

Lines of code

1215

increased by317.53%

Number of lines in readme file

69

increased by23.21%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes