@vonage/number-insights - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

package.json

 {
     "name": "@vonage/number-insights",
-    "version": "1.3.0",
+    "version": "1.4.0",
     "description": "Vonage Number Insights API",
@@ -30,5 +30,5 @@ "homepage": "https://developer.vonage.com",
     "dependencies": {
-        "@vonage/auth": "^1.2.0",
-        "@vonage/server-client": "^1.3.0",
-        "@vonage/vetch": "^1.2.0"
+        "@vonage/auth": "^1.3.0",
+        "@vonage/server-client": "^1.4.0",
+        "@vonage/vetch": "^1.3.0"
     },
@@ -35,0 +35,0 @@ "devDependencies": {

README.md

 # Vonage Number Insights SDK for Node.js
 
-![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/vonage/vonage-node-sdk/Vonage/3.x?logo=github&style=flat-square&label=Workflow%20Build)
-[![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk)
-![Latest Release](https://img.shields.io/npm/v/@vonage/number-insights)
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md)
-[![License](https://img.shields.io/npm/l/@vonage/number-insights?label=License&style=flat-square)][license]
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/number-insights?label=%40vonage%2Fnumber-insights&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license]
 
 <img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" />
 
-This is the Vonage Number Insights SDK for Node.js for use with
-[Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage
-account. Sign up [for free at vonage.com][signup].
+This is the Vonage Number Insights SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup].
 
-We recommend using this package as part of the overall [
-`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk).
-
 For full API documentation refer to [developer.nexmo.com](https://developer.nexmo.com/).
 
 * [Installation](#installation)
-* [Usage](#using-the-vonage-number-insights-sdk)
+* [Usage](#usage)
 * [Promises](#promises)
@@ -27,8 +18,5 @@ * [Testing](#testing)
 
-We recommend using this SDK as part of the overall [
-`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk).
-Please see the main package for installation.
+We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation.
 
-You can also use this SDK standalone if you only need access to just the
-Messages API.
+You can also use this SDK standalone if you only need access to just the Messages API.
 
@@ -47,8 +35,7 @@ ### With NPM
 
-## Using the Vonage Number Insights SDK
+## Usage
 
 ### As part of the Vonage Server SDK
 
-If you are using this SDK as part of the Vonage Server SDK, you can access it
-as the `messages` property off of the client that you instantiate.
+If you are using this SDK as part of the Vonage Server SDK, you can access it as the `messages` property off of the client that you instantiate.
 
@@ -60,4 +47,4 @@ ```js
 const credentials = new Auth({
-    apiKey: API_KEY,
-    apiSecret: API_SECRET
+  apiKey: API_KEY,
+  apiSecret: API_SECRET
 });
@@ -74,7 +61,3 @@ const options = {};
 
-The SDK can be used standalone from the main [
-Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if
-you only need to use the Messages API. All you need to do is
-`require('@vonage/messages')`, and use the returned object to create your own
-client.
+The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Messages API. All you need to do is `require('@vonage/number-insights')`, and use the returned object to create your own client.
 
@@ -86,4 +69,4 @@ ```js
 const credentials = new Auth({
-    apiKey: API_KEY,
-    apiSecret: API_SECRET
+  apiKey: API_KEY,
+  apiSecret: API_SECRET
 });
@@ -95,9 +78,7 @@ const options = {};
 
-Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/tree/3.x/readme/packages/auth#options),
-and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/tree/3.x/readme/packages/server-client#options)
+Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options)
 
 ## Promises
 
-Most methods that interact with the Vonage API uses Promises. You can either
-resolve these yourself, or use `await` to wait for a response.
+Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response.
 
@@ -104,0 +85,0 @@ ```js

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

Worsened metrics

Total package byte prevSize

19111

decreased by-1%

Number of lines in readme file

97

decreased by-16.38%

Dependency changes

• Updated@vonage/auth@^1.3.0

• Updated@vonage/server-client@^1.4.0

• Updated@vonage/vetch@^1.3.0