@radio-retail/api-client - npm Package Compare versions

Comparing version 3.7.1 to 3.7.2

package.json

 {
   "name": "@radio-retail/api-client",
   "description": "Radio Retail API client",
-  "version": "3.7.1",
+  "version": "3.7.2",
   "main": "dist/index.js",
   "scripts": {
-    "prepublish": "npm run build",
-    "fmt": "prettier --write \"src/**/*.js\"",
-    "build": "babel src -d dist",
-    "test": "jest"
+    "prepare": "npm run build",
+    "format": "prettier --write \"$PWD/src/**/*.js\"",
+    "build": "babel src -d dist"
   },
@@ -29,10 +28,5 @@ "files": [
   "peerDependencies": {
-    "axios": "^0.19.0"
+    "axios": "*"
   },
   "license": "MPL-2.0",
-  "jest": {
-    "setupFilesAfterEnv": [
-      "<rootDir>/setup-tests.js"
-    ]
-  },
   "dependencies": {
@@ -39,0 +33,0 @@ "qs": "^6.9.4"

README.md

 # @radio-retail/api-client
 
 > Radio Retail API client
+
+## Usage
+
+```js
+import api from '@radio-retail/api-client'
+```
+
+
+## Install
+
+This project uses [node](https://nodejs.org) and [npm](https://www.npmjs.com).
+
+```sh
+$ npm install @radio-retail/api-client
+$ # OR
+$ yarn add @radio-retail/api-client
+
+
+## Publishing
+
+This module uses the [Automated releases for npm packages](https://github.com/marketplace/actions/automated-releases-for-npm-packages) Github action for releasing when pushed to the `master` branch.
+
+### Versioning
+
+- If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major version will be incremented.
+- If a commit message begins with the string "feat" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
+- All other changes will increment the patch version.
+
+### FAQS
+
+- What is going on with the `package.json` version? See the [Script does not update package.json issue](https://github.com/mikeal/merge-release/issues/12)

No alert changes

Improved metrics

Total package byte prevSize

25196

increased by3.09%

Number of lines in readme file

35

increased by775%

Worsened metrics

Number of package files

20

decreased by-4.76%

Lines of code

555

decreased by-0.89%

No dependency changes