electron
/
addon-tools-el
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adjust readme

This commit is contained in:
Luis Blanco 2022-09-24 19:11:40 +04:00
parent 847a68a2d2
commit f9fe9f0124
4 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -9,15 +9,12 @@ This is a part of [Node3D](https://github.com/node-3d) project.
npm i addon-tools-raub npm i addon-tools-raub
``` ```
## Synopsis
This module contains numerous helpers for Node.js **NAPI** This module contains numerous helpers for Node.js **NAPI**
addons and dependency packages. On this page, helper scripts addons and dependency packages. On this page, helper scripts
are described. For details on **addon-tools.hpp** and some are described. For details on **addon-tools.hpp** and some
additional snippets follow the links below. additional snippets follow the links below.
**Go to**: **Docs**:
* [include/addon-tools.hpp](doc/addon-tools.md) * [include/addon-tools.hpp](doc/addon-tools.md)
@ -32,6 +29,8 @@ additional snippets follow the links below.
## index.js ## index.js
> NOTE: peer dependency `node-addon-api` is required for this helper.
Main exports for cross-platform addon configuration. Main exports for cross-platform addon configuration.
See [TypeScript definitions](/index.d.ts) with comments. See [TypeScript definitions](/index.d.ts) with comments.
@ -50,6 +49,8 @@ See [TypeScript definitions](/cpbin.d.ts) with comments.
## install.js ## install.js
> NOTE: peer dependency `adm-zip` is required for this helper.
Downloads and unzips the platform specific binary for the calling package. Downloads and unzips the platform specific binary for the calling package.
See [TypeScript definitions](/install.d.ts) with comments. See [TypeScript definitions](/install.d.ts) with comments.

1
doc/snippets.md
View File

@ -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. separate folder with a separate **package.json**, **binding.gyp** and the sources.
A snippet for **src/package.json**: A snippet for **src/package.json**:
``` ```
{ {
"name": "build", "name": "build",

18
package-lock.json generated
View File

@ -9,21 +9,21 @@
"version": "6.0.0", "version": "6.0.0",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"adm-zip": "~0.5.9", "adm-zip": "^0.5.9",
"eslint": "~8.24.0", "eslint": "^8.24.0",
"eslint-plugin-jest": "~27.0.4", "eslint-plugin-jest": "^27.0.4",
"eslint-plugin-node": "~11.1.0", "eslint-plugin-node": "^11.1.0",
"jest": "~29.0.3", "jest": "^29.0.3",
"node-addon-api": "~5.0.0", "node-addon-api": "^5.0.0",
"typescript": "~4.8.3" "typescript": "^4.8.3"
}, },
"engines": { "engines": {
"node": ">=16.17.0", "node": ">=16.17.0",
"npm": ">=8.15.0" "npm": ">=8.15.0"
}, },
"peerDependencies": { "peerDependencies": {
"adm-zip": "~0.5.9", "adm-zip": "^0.5.9",
"node-addon-api": "~5.0.0" "node-addon-api": "^5.0.0"
} }
}, },
"node_modules/@ampproject/remapping": { "node_modules/@ampproject/remapping": {

18
package.json
View File

@ -67,16 +67,16 @@
"url": "https://github.com/node-3d/addon-tools-raub.git" "url": "https://github.com/node-3d/addon-tools-raub.git"
}, },
"peerDependencies": { "peerDependencies": {
"adm-zip": "~0.5.9", "adm-zip": "^0.5.9",
"node-addon-api": "~5.0.0" "node-addon-api": "^5.0.0"
}, },
"devDependencies": { "devDependencies": {
"adm-zip": "~0.5.9", "adm-zip": "^0.5.9",
"eslint-plugin-jest": "~27.0.4", "eslint-plugin-jest": "^27.0.4",
"eslint-plugin-node": "~11.1.0", "eslint-plugin-node": "^11.1.0",
"eslint": "~8.24.0", "eslint": "^8.24.0",
"jest": "~29.0.3", "jest": "^29.0.3",
"node-addon-api": "~5.0.0", "node-addon-api": "^5.0.0",
"typescript": "~4.8.3" "typescript": "^4.8.3"
} }
} }