diff options
Diffstat (limited to 'node_modules/node-addon-api/doc/conversion-tool.md')
| -rw-r--r-- | node_modules/node-addon-api/doc/conversion-tool.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/node_modules/node-addon-api/doc/conversion-tool.md b/node_modules/node-addon-api/doc/conversion-tool.md new file mode 100644 index 0000000..3b50b9c --- /dev/null +++ b/node_modules/node-addon-api/doc/conversion-tool.md @@ -0,0 +1,28 @@ +# Conversion Tool + +To make the migration to **node-addon-api** easier, we have provided a script to +help complete some tasks. + +## To use the conversion script: + + 1. Go to your module directory + +``` +cd [module_path] +``` + + 2. Install node-addon-api module + +``` +npm install node-addon-api +``` + 3. Run node-addon-api conversion script + +``` +node ./node_modules/node-addon-api/tools/conversion.js ./ +``` + + 4. While this script makes conversion easier, it still cannot fully convert +the module. The next step is to try to build the module and complete the +remaining conversions necessary to allow it to compile and pass all of the +module's tests.
\ No newline at end of file |