diff --git a/README.md b/README.md index bdf5a52..6d47c01 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,13 @@ Pretzel is Mac desktop app that shows and search keyboard shortcuts based on you ## Run it locally (if you are curious): +### Important! Because Pretzel has a dependency [node-ffi](https://github.com/node-ffi/node-ffi) that requires node v8, until `node-ffi` is compaitable with +latest node, you should use `nvm` to install node v8 to run Pretzel locally. Otherwise, `npm install` would give you some error regarding node-gyp. + ``` +nvm install 8.11.3 # I personally use this version +nvm ls # to make sure we are currently using node v8 + npm install npm start ```