i18n-postal-address - npm Package Compare versions

Comparing version 0.7.1 to 0.8.0

package.json

 {
   "name": "i18n-postal-address",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "A JavaScript library to produce international postal addresses formatted by region for node and the web",
@@ -68,21 +68,19 @@ "homepage": "https://joaocarmo.com/i18n-postal-address-playground",
   "dependencies": {},
-  "peerDependencies": {
+  "optionalDependencies": {
     "node-postal": "^1.1.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.0",
-    "@babel/plugin-transform-runtime": "^7.22.15",
+    "@babel/core": "^7.23.2",
+    "@babel/plugin-transform-runtime": "^7.23.2",
     "@babel/preset-env": "^7.22.20",
     "@babel/preset-typescript": "^7.23.0",
-    "@babel/runtime": "^7.23.1",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20.8.2",
-    "@types/node-postal": "^1.1.1",
-    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
-    "babel-eslint": "^10.1.0",
+    "@types/jest": "^29.5.6",
+    "@types/node": "^20.8.7",
+    "@types/node-postal": "^1.1.2",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
     "babel-jest": "^29.7.0",
     "babel-loader": "^9.1.3",
     "core-js": "^3.33.0",
-    "eslint": "^8.50.0",
+    "eslint": "^8.51.0",
     "eslint-config-airbnb-base": "^15.0.0",
@@ -93,3 +91,3 @@ "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-plugin-jest": "^27.4.2",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "husky": ">=8.0.3",
@@ -96,0 +94,0 @@ "jest": "^29.7.0",

README.md

@@ -5,4 +5,2 @@ # i18n-postal-address
 ![Tests](https://github.com/joaocarmo/i18n-postal-address/workflows/Tests/badge.svg)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/joaocarmo/i18n-postal-address.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/joaocarmo/i18n-postal-address/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/joaocarmo/i18n-postal-address.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/joaocarmo/i18n-postal-address/context:javascript)
 
@@ -232,2 +230,4 @@ A JavaScript library to produce international postal addresses formatted by
 experimental support for parsing addresses using some existing libraries.
+However, note that these are optional and not required for the primary
+functionality of this library.
 
@@ -239,9 +239,16 @@ ### libpostal
 
-#### Requirements
+#### Optional Requirements for libpostal Support
 
+If you wish to utilize the `libpostal` experimental features, follow these
+steps:
+
 1. Install [libpostal][libpostal] following their installation instructions, or
-   execute [this script][install-libpostal] if you're on a \*nix machine
-2. Install [node-postal][node-postal] as a dependency in your project, _after
-   installing libpostal_
+   execute [this script][install-libpostal] if you're on a \*nix machine.
+2. Install [node-postal][node-postal] as an **optional** dependency in your
+   project, _after installing libpostal_. This is not required for the core
+   functionality but only if you want to use the `libpostal` features.
 
+Remember, these steps are optional and are only for users interested in the
+experimental string parsing feature.
+
 #### Experimental usage
@@ -248,0 +255,0 @@

No alert changes

Improved metrics

Dev dependency count

28

decreased by-6.67%

Number of lines in readme file

322

increased by2.22%

Worsened metrics

Total package byte prevSize

86795

decreased by-0.01%

No dependency changes