Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Santeri Hiltunen committed Oct 10, 2017
1 parent 1fd1070 commit b58736f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# node-shim

Shim node, npm and yarn binaries to use the correct version according to `engines` field in `package.json`. The file is found by traversing the current directory hierarchy up and the first one found is used. If no `package.json` is found the shims default to the global node, npm or yarn.
Shim node, npm and yarn binaries to use the correct version according to `engines` field in `package.json`. The file is found by traversing the current directory hierarchy up and the first one found is used. If no `package.json` is found or it doesn't have a version for the program the shims default to the global node, npm or yarn.

This app is a work in progress so a lot of features that you would expect are missing. Some known issues are:

- Has only been tested on macOS (might work on Linux)
- Semver ranges aren't supported (range is discarded and the exact version specified is used)
- node, npm and yarn have to be downloaded manually and be put to the correct location like `~/.local/opt/node-shim/yarn/1.1.0`
- Global node, npm and yarn binaries are only searched from `/usr/local/bin`
- `package.json` is required to have versions for all the programs supported by `node-shim` (node, npm and yarn)

That said it works pretty well for me right now but might not work for you yet.

To enable debug logging to `stderr` you can set `NODE_SHIM_DEBUG` environment variable to `"true"`.

## Installing

You can download the latest release from [GitHub releases](https://github.com/Hilzu/node-shim/releases). Extract the file and run the `install.sh` script. By default it copies the necessary files to `~/bin`. You can also install the app by running `make && make install`.
Expand Down

0 comments on commit b58736f

Please sign in to comment.