Skip to content

Commit

Permalink
Remove NodeJS v4 support
Browse files Browse the repository at this point in the history
  • Loading branch information
recrsn committed Jul 1, 2018
1 parent a78d381 commit 849b14d
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 25 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Expand Up @@ -12,5 +12,8 @@ insert_final_newline = true
indent_style = space
indent_size = 2

[appveyor.yml]
end_of_line = crlf

[*.md]
trim_trailing_whitespace = false
2 changes: 0 additions & 2 deletions .travis.yml
Expand Up @@ -8,8 +8,6 @@ os:
- osx

node_js:
- "4"
- "5"
- "6"
- "7"
- "8"
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
@@ -1,6 +1,11 @@
# UNRELEASED

* Drop support for NodeJS <= 4

# 2.0.1 (2018-04-20)

* Update `node-pre-gyp` to allow downloading prebuilt modules

# 2.0.0 (2018-04-07)

* Make `2b` the default bcrypt version
Expand Down
27 changes: 22 additions & 5 deletions README.md
Expand Up @@ -23,8 +23,9 @@ If you are on a stable version of node, we can't magically know what you are doi
| 0.8.x | >= 0.5.x |
| 0.10.x | >= 0.5.x |
| 0.11.x | >= 0.8.x |

Windows users should make sure to have at least node 0.8.5 installed and version >= 0.7.1 of this module.
| 4.x.x | <= 2.0.x |
| 8.x.x | >= 1.0.3 |
| 10.x.x | >= 3.0.0 |

`node-gyp` only works with stable/released versions of node. Since the `bcrypt` module uses `node-gyp` to build and install you'll need a stable version of node to use bcrypt. If you do not you'll likely see an error that starts with:

Expand All @@ -50,8 +51,7 @@ Compatibility with hashes generated by other languages is not 100% guaranteed du

### Migrating from v1.0.x

Hashes generated in earlier version of `bcrypt` remain 100% supported in `v2.x.x`. In most cases, the migration
should be a bump in the `package.json`.
Hashes generated in earlier version of `bcrypt` remain 100% supported in `v2.x.x` and later versions. In most cases, the migration should be a bump in the `package.json`.

Hashes generated in `v2.x.x` using the defaults parameters will not work in earlier versions.

Expand All @@ -65,13 +65,30 @@ Hashes generated in `v2.x.x` using the defaults parameters will not work in earl
* `OpenSSL` - This is only required to build the `bcrypt` project if you are using versions <= 0.7.7. Otherwise, we're using the builtin node crypto bindings for seed data (which use the same OpenSSL code paths we were, but don't have the external dependency).

## Install via NPM
Make sure you have the appropriate dependencies installed and configured for your platform. You can find installation instructions for the dependencies for some common platforms [in this page][depsinstall].

```
npm install bcrypt
```
***Note:*** OS X users using Xcode 4.3.1 or above may need to run the following command in their terminal prior to installing if errors occur regarding xcodebuild: ```sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer```

_Pre-built binaries for various NodeJS versions are made available on a best-effort basis._

Only the current stable and the supported LTS releases are actively tested against. Please note that there may be an interval between the release of the module and the availabilty of the compiled modules.

Currently, we have pre-built binaries that support the following platforms:

1. Windows x32 and x64
2. Linux x64 (GlibC targets only). Pre-built binaries for MUSL targets such as Apline Linux are not available.
3. macOS

If you face an error like this:

```
node-pre-gyp ERR! Tried to download(404): https://github.com/kelektiv/node.bcrypt.js/releases/download/v1.0.2/bcrypt_lib-v1.0.2-node-v48-linux-x64.tar.gz
```

Make sure you have the appropriate dependencies installed and configured for your platform. You can find installation instructions for the dependencies for some common platforms [in this page][depsinstall].

## Usage

### async (recommended)
Expand Down
8 changes: 0 additions & 8 deletions appveyor.yml
@@ -1,13 +1,5 @@
environment:
matrix:
- nodejs_version: "4"
platform: x64
- nodejs_version: "4"
platform: x86
- nodejs_version: "5"
platform: x64
- nodejs_version: "5"
platform: x86
- nodejs_version: "6"
platform: x64
- nodejs_version: "6"
Expand Down
10 changes: 0 additions & 10 deletions werker.yml

This file was deleted.

0 comments on commit 849b14d

Please sign in to comment.