From f9fe9f0124b6a1c8d448d48b107f07d1dce7f2b8 Mon Sep 17 00:00:00 2001
From: Luis Blanco <luisblanco1337@gmail.com>
Date: Sat, 24 Sep 2022 19:11:40 +0400
Subject: [PATCH] Adjust readme

---
 README.md         |  9 +++++----
 doc/snippets.md   |  1 +
 package-lock.json | 18 +++++++++---------
 package.json      | 18 +++++++++---------
 4 files changed, 24 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 7886a54..d03452c 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,12 @@ This is a part of [Node3D](https://github.com/node-3d) project.
 npm i addon-tools-raub
 ```
 
-
-## Synopsis
-
 This module contains numerous helpers for Node.js **NAPI**
 addons and dependency packages. On this page, helper scripts
 are described. For details on **addon-tools.hpp** and some
 additional snippets follow the links below.
 
-**Go to**:
+**Docs**:
 
 * [include/addon-tools.hpp](doc/addon-tools.md)
 	
@@ -32,6 +29,8 @@ additional snippets follow the links below.
 
 ## index.js
 
+> NOTE: peer dependency `node-addon-api` is required for this helper.
+
 Main exports for cross-platform addon configuration.
 See [TypeScript definitions](/index.d.ts) with comments.
 
@@ -50,6 +49,8 @@ See [TypeScript definitions](/cpbin.d.ts) with comments.
 
 ## install.js
 
+> NOTE: peer dependency `adm-zip` is required for this helper.
+
 Downloads and unzips the platform specific binary for the calling package.
 See [TypeScript definitions](/install.d.ts) with comments.
 
diff --git a/doc/snippets.md b/doc/snippets.md
index 16669eb..d4af7ec 100644
--- a/doc/snippets.md
+++ b/doc/snippets.md
@@ -7,6 +7,7 @@ put the file **binding.gyp** to the module root anymore. It is better to have a
 separate folder with a separate **package.json**, **binding.gyp** and the sources.
 
 A snippet for **src/package.json**:
+
 ```
 {
 	"name": "build",
diff --git a/package-lock.json b/package-lock.json
index d60a4f7..89625d9 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,21 +9,21 @@
 			"version": "6.0.0",
 			"license": "MIT",
 			"devDependencies": {
-				"adm-zip": "~0.5.9",
-				"eslint": "~8.24.0",
-				"eslint-plugin-jest": "~27.0.4",
-				"eslint-plugin-node": "~11.1.0",
-				"jest": "~29.0.3",
-				"node-addon-api": "~5.0.0",
-				"typescript": "~4.8.3"
+				"adm-zip": "^0.5.9",
+				"eslint": "^8.24.0",
+				"eslint-plugin-jest": "^27.0.4",
+				"eslint-plugin-node": "^11.1.0",
+				"jest": "^29.0.3",
+				"node-addon-api": "^5.0.0",
+				"typescript": "^4.8.3"
 			},
 			"engines": {
 				"node": ">=16.17.0",
 				"npm": ">=8.15.0"
 			},
 			"peerDependencies": {
-				"adm-zip": "~0.5.9",
-				"node-addon-api": "~5.0.0"
+				"adm-zip": "^0.5.9",
+				"node-addon-api": "^5.0.0"
 			}
 		},
 		"node_modules/@ampproject/remapping": {
diff --git a/package.json b/package.json
index 8b6b678..05a6e58 100644
--- a/package.json
+++ b/package.json
@@ -67,16 +67,16 @@
 		"url": "https://github.com/node-3d/addon-tools-raub.git"
 	},
 	"peerDependencies": {
-		"adm-zip": "~0.5.9",
-		"node-addon-api": "~5.0.0"
+		"adm-zip": "^0.5.9",
+		"node-addon-api": "^5.0.0"
 	},
 	"devDependencies": {
-		"adm-zip": "~0.5.9",
-		"eslint-plugin-jest": "~27.0.4",
-		"eslint-plugin-node": "~11.1.0",
-		"eslint": "~8.24.0",
-		"jest": "~29.0.3",
-		"node-addon-api": "~5.0.0",
-		"typescript": "~4.8.3"
+		"adm-zip": "^0.5.9",
+		"eslint-plugin-jest": "^27.0.4",
+		"eslint-plugin-node": "^11.1.0",
+		"eslint": "^8.24.0",
+		"jest": "^29.0.3",
+		"node-addon-api": "^5.0.0",
+		"typescript": "^4.8.3"
 	}
 }