diff --git a/README.md b/README.md index 3f5f8ef..f9a5503 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # quoted-printable -Fast, robust RFC 2045 (Quoted-Printable) and RFC 2047 (Q-Encoding) encoder/decoder for Buffers in pure Javascript with an optional C++ binding. Avoids intermediary string allocations and regular expressions. Reduces branching through the use of lookup tables. +Fast, robust RFC 2045 (Quoted-Printable) and RFC 2047 (Q-Encoding) encoder/decoder for Buffers in pure Javascript with an optional C++ binding. Avoids intermediary string allocations and regular expressions. Reduces branching through the use of lookup tables. This is a fork of [@ronomon/quoted-printable](https://github.com/ronomon/quoted-printable/) modified to support Node.js v12. ## Installation #### Linux, OS X This will compile the native binding automatically: ``` -npm install @ronomon/quoted-printable +npm install @vlasky/quoted-printable ``` #### Windows This will skip compiling the native binding automatically: ``` -npm install --ignore-scripts @ronomon/quoted-printable +npm install --ignore-scripts @vlasky/quoted-printable ``` ## Performance @@ -75,13 +75,13 @@ npm install --ignore-scripts @ronomon/quoted-printable ``` ## Native Binding (Optional) -The native binding will be installed automatically when installing `@ronomon/quoted-printable` without the `--ignore-scripts` argument. The Javascript binding will be used if the native binding could not be compiled or is not available. To compile the native binding manually after installing, install [node-gyp](https://www.npmjs.com/package/node-gyp) globally: +The native binding will be installed automatically when installing `@vlasky/quoted-printable` without the `--ignore-scripts` argument. The Javascript binding will be used if the native binding could not be compiled or is not available. To compile the native binding manually after installing, install [node-gyp](https://www.npmjs.com/package/node-gyp) globally: ``` sudo npm install node-gyp -g ``` -Then build the binding from within the `@ronomon/quoted-printable` module directory: +Then build the binding from within the `@vlasky/quoted-printable` module directory: ``` -cd node_modules/@ronomon/quoted-printable +cd node_modules/@vlasky/quoted-printable node-gyp rebuild ``` @@ -89,7 +89,7 @@ node-gyp rebuild #### Encoding ```javascript -var QuotedPrintable = require('@ronomon/quoted-printable'); +var QuotedPrintable = require('@vlasky/quoted-printable'); var string = ' = '; var options = { qEncoding: false }; var buffer = Buffer.from(string, 'utf-8'); @@ -100,7 +100,7 @@ console.log(bufferEncoded.toString('ascii')); #### Decoding ```javascript -var QuotedPrintable = require('@ronomon/quoted-printable'); +var QuotedPrintable = require('@vlasky/quoted-printable'); var string = ' =3D=20'; var options = { qEncoding: false }; var bufferEncoded = Buffer.from(string, 'ascii'); diff --git a/package-lock.json b/package-lock.json index 22bc6f7..276c719 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@ronomon/quoted-printable", + "name": "@vlasky/quoted-printable", "version": "3.2.1", "lockfileVersion": 1, "requires": true, @@ -10,9 +10,9 @@ "integrity": "sha512-+Dnc8cNXa0mI1cD+YdA3mmQP8j1CjQKXfILiXgZGWAtauMIUxuhRgnOLgabKjEj+Wa8r2rQKsaNaDayxauImGQ==" }, "nan": { - "version": "2.10.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.10.0.tgz", - "integrity": "sha512-bAdJv7fBLhWC+/Bls0Oza+mvTaNQtP+1RyhhhvD95pgUJz6XM5IzgmxOkItJ9tkoCiplvAnXI1tNmmUD/eScyA==" + "version": "2.14.2", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.14.2.tgz", + "integrity": "sha512-M2ufzIiINKCuDfBSAUr1vWQ+vuVcA9kqx8JJUsbQi6yf1uGRyb7HfpdfUr5qLXf3B/t8dPvcjhKMmlfnP47EzQ==" } } } diff --git a/package.json b/package.json index a8c5e14..072600a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@ronomon/quoted-printable", + "name": "@vlasky/quoted-printable", "version": "3.2.1", - "description": "Fast, robust RFC 2045 (Quoted-Printable) and RFC 2047 (Q-Encoding) encoder/decoder for Buffers in pure Javascript with an optional C++ binding.", + "description": "Fast, robust RFC 2045 (Quoted-Printable) and RFC 2047 (Q-Encoding) encoder/decoder for Buffers in pure Javascript with an optional C++ binding. A fork of @ronomon/quoted-printable that supports Node.js v12.", "main": "index.js", "files": [ "benchmark.js", @@ -12,7 +12,7 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/ronomon/quoted-printable.git" + "url": "git+https://github.com/vlasky/quoted-printable.git" }, "keywords": [ "quoted-printable", @@ -21,12 +21,12 @@ "rfc 2045", "rfc 2047" ], - "author": "Joran Dirk Greef", + "author": "Joran Dirk Greef", "Vlad Lasky" "license": "MIT", "bugs": { "url": "https://github.com/ronomon/quoted-printable/issues" }, - "homepage": "https://github.com/ronomon/quoted-printable#readme", + "homepage": "https://github.com/vlasky/quoted-printable#readme", "scripts": { "postinstall": "node-gyp clean", "test": "node test.js"