summaryrefslogtreecommitdiff
path: root/node_modules/nan/tools/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/nan/tools/README.md')
-rw-r--r--node_modules/nan/tools/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/node_modules/nan/tools/README.md b/node_modules/nan/tools/README.md
new file mode 100644
index 0000000..7f07e4b
--- /dev/null
+++ b/node_modules/nan/tools/README.md
@@ -0,0 +1,14 @@
+1to2 naively converts source code files from NAN 1 to NAN 2. There will be erroneous conversions,
+false positives and missed opportunities. The input files are rewritten in place. Make sure that
+you have backups. You will have to manually review the changes afterwards and do some touchups.
+
+```sh
+$ tools/1to2.js
+
+ Usage: 1to2 [options] <file ...>
+
+ Options:
+
+ -h, --help output usage information
+ -V, --version output the version number
+```