argon2 - npm Package Compare versions
Comparing version 0.26.0 to 0.26.1
| { | ||
| "name": "argon2", | ||
| "version": "0.26.0", | ||
| "version": "0.26.1", | ||
| "description": "An Argon2 library for Node", | ||
@@ -64,3 +64,2 @@ "main": "argon2.js", | ||
| "module_path": "./lib/binding/", | ||
| "package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}-{libc}.tar.gz", | ||
| "host": "https://github.com/ranisalt/node-argon2/releases/download/", | ||
@@ -70,3 +69,3 @@ "remote_path": "v{version}" | ||
| "engines": { | ||
| "node": ">=8.0.0" | ||
| "node": ">=10.0.0" | ||
| }, | ||
@@ -73,0 +72,0 @@ "standard": { |
@@ -95,3 +95,18 @@ # node-argon2 | ||
| ### Before installing | ||
| ### Prebuilt Binaries | ||
| **node-argon2** provides prebuilt binaries from `v0.26.0` onwards. They are | ||
| built per release using GitHub Actions. | ||
| The current prebuilt binaries are built (and tested) with the following matrix: | ||
| 1. Node 10.x, 12.x, 13.x | ||
| 2. Ubuntu 16.04, Windows Server 2019, macOS Catalina 10.15 | ||
| If your plaform is below the above requirements, you can follow the | ||
| [Before Installing](#before-installing) section below to manually compile from | ||
| source. It is also always recommended to build from source to ensure consistency | ||
| of the compiled module. | ||
| ### Before Installing | ||
| > You can skip this section if the prebuilt binaries work for you. | ||
| You **MUST** have a **node-gyp** global install before proceeding with install, | ||
@@ -101,3 +116,3 @@ along with GCC >= 5 / Clang >= 3.3. On Windows, you must compile under Visual | ||
| **node-argon2** works only and is tested against Node >=8.0.0. | ||
| **node-argon2** works only and is tested against Node >=10.0.0. | ||
@@ -126,2 +141,36 @@ #### OSX | ||
| ### FAQ | ||
| <details> | ||
| <summary>How do I manually rebuild the binaries?</summary> | ||
| ```console | ||
| $ npx node-pre-gyp rebuild -C ./node_modules/argon2 | ||
| ``` | ||
| > Run `node-pre-gyp` instead of `node-gyp` because node-argon2's `binding.gyp` | ||
| file relies on variables from `node-pre-gyp`. | ||
| > You can omit `npx` if you have a global installation of `node-pre-gyp`, | ||
| otherwise prefixing `npx` will use the local one in `./node_modules/.bin` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| How do I skip installing prebuilt binaries and manually compile from source? | ||
| </summary> | ||
| You can do either of the two methods below: | ||
| 1. Force build from source on install. | ||
| ```console | ||
| $ npm install argon2 --build-from-source | ||
| ``` | ||
| 2. Ignore `node-argon2` install script and build manually. | ||
| ```console | ||
| $ npm install argon2 --ignore-scripts | ||
| $ npx node-pre-gyp rebuild -C ./node_modules/argon2 | ||
| ``` | ||
| </details> | ||
| # License | ||
@@ -136,3 +185,3 @@ Work licensed under the [MIT License](LICENSE). Please check | ||
| [npm-url]: https://www.npmjs.com/package/argon2 | ||
| [actions-image]: https://img.shields.io/github/workflow/status/ranisalt/node-argon2/ci?style=flat-square | ||
| [actions-image]: https://img.shields.io/github/workflow/status/ranisalt/node-argon2/CI?style=flat-square | ||
| [actions-url]: https://github.com/ranisalt/node-argon2/actions | ||
@@ -139,0 +188,0 @@ [coverage-image]: https://img.shields.io/coveralls/github/ranisalt/node-argon2/master.svg?style=flat-square |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.81%
180754
- Number of lines in readme file
- increased by34.75%
190