summaryrefslogtreecommitdiff
path: root/node_modules/node-addon-api/doc/generator.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/node-addon-api/doc/generator.md')
-rw-r--r--node_modules/node-addon-api/doc/generator.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/node_modules/node-addon-api/doc/generator.md b/node_modules/node-addon-api/doc/generator.md
new file mode 100644
index 0000000..9167480
--- /dev/null
+++ b/node_modules/node-addon-api/doc/generator.md
@@ -0,0 +1,13 @@
+# Generator
+
+## What is generator
+
+**[generator-napi-module](https://www.npmjs.com/package/generator-napi-module)** is a module to quickly generate a skeleton module using
+**N-API**, the new API for Native addons. This module automatically sets up your
+**gyp file** to use **node-addon-api**, the C++ wrappers for N-API and generates
+a wrapper JS module. Optionally, it can even configure the generated project to
+use **TypeScript** instead.
+
+## **generator-napi-module** reference
+
+ - [Installation and usage](https://www.npmjs.com/package/generator-napi-module#installation)