From 688b7b08a90e74d181e17ea2da6ee543698da688 Mon Sep 17 00:00:00 2001 From: Luis Blanco Date: Mon, 5 Aug 2019 17:14:11 +0300 Subject: [PATCH] wip readme --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 72b0f6e..edce140 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,9 @@ would encourage you to abide by the following rules: * Your binary directories are: - * bin-win64 - * bin-linux64 - * bin-mac64 + * bin-windows + * bin-linux + * bin-osx * The following piece of code in your `index.js` without changes. Method `paths()` is described [here](#indexjs). @@ -103,8 +103,6 @@ is described [here](#indexjs). module.exports = require('addon-tools-raub').paths(__dirname); ``` -* Your whole **binding.gyp**: -
Show binding.gyp @@ -298,13 +296,11 @@ const core = require(`./${binPath}/MY_ADDON`); ## include/addon-tools.hpp There is a C++ header file, `addon-tools.hpp`, shipped with this package. It -introduces several useful macros and utilities. Also it includes Nan automatically, +introduces several useful macros and utilities. Also it includes Napi automatically, so that you can replace: ``` -// #include // already in node.h -// #include // already in nan.h -#include +#include ``` with @@ -318,8 +314,7 @@ As it was mentioned above, this can be done automatically. Also an actual path t directory is exported from the module and is accessible like this: ``` -require('addon-tools-raub').include() // implicit console.log() -require('addon-tools-raub').includePath // just a string +require('addon-tools-raub').include // a string ``` Currently, there are following helpers in **addon-tools.hpp**: