@libp2p/tracked-map - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

package.json

 {
   "name": "@libp2p/tracked-map",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Allows tracking of statistics while libp2p is running",
@@ -25,3 +25,3 @@ "license": "Apache-2.0 OR MIT",
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
@@ -139,3 +139,4 @@ "!**/*.tsbuildinfo"
     "test:electron-main": "aegir test -t electron-main",
-    "release": "aegir release"
+    "release": "aegir release",
+    "docs": "aegir docs"
   },
@@ -147,5 +148,5 @@ "dependencies": {
     "aegir": "^37.0.7",
-    "sinon": "^14.0.0",
+    "sinon": "^15.0.1",
     "sinon-ts": "^1.0.0"
   }
 }

README.md

@@ -6,3 +6,3 @@ # @libp2p/tracked-map <!-- omit in toc -->
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-tracked-map.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tracked-map)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-tracked-map/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-tracked-map/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-tracked-map/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-tracked-map/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
@@ -14,6 +14,8 @@ > Allows tracking of statistics while libp2p is running
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Description](#description)
 - [Example](#example)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribute](#contribute)
+- [Contribution](#contribution)
 
@@ -26,2 +28,10 @@ ## Install
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pTrackedMap` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/tracked-map/dist/index.min.js"></script>
+```
+
 ## Description
@@ -43,2 +53,6 @@
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-tracked-map>
+
 ## License
@@ -51,4 +65,4 @@
 
-## Contribute
+## 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

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

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

11276

increased by20.99%

Number of package files

10

increased by25%

Lines of code

101

increased by10.99%

Number of lines in readme file

64

increased by28%

No dependency changes