diff --git a/README.md b/README.md index b3a140e..8aa8b17 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ npm install --save runtime-node-refresh # Usage -Following you will find example of simple project created via `npm` which uses `runtime-node-refresh` to refresh environment variable without running the node script again. The message to update environment variable came from other node process. +Following you will find example of simple project created via `npm` which uses `runtime-node-refresh` to refresh environment variable without running the node script again. Notice that the message to update environment variable came from other node process. Create `index.js` file and add the following code: @@ -35,7 +35,7 @@ Create `package.json' file and fill it with the following: "refresh": "runtime-node-refresh" }, "dependencies": { - "runtime-node-refresh": "^1.0.3" + "runtime-node-refresh": "^1.0.6" } } ``` @@ -60,4 +60,7 @@ It may be very usefult when you want to restart/update environment variable on r The real life example of `RnR` lib usage can be find in the following express based web-application: https://github.com/przemek-nowicki/node-express-template.ts/blob/master/src/server.ts -Note: RnR is using node signals which means it does not work on Worker threads. \ No newline at end of file +**Note:** RnR is using node signals which means it does not work on Worker threads. +It uses SIGPIPE signal to communicate between nodejs processes. +By default the SIGPIPE is ignored by NodeJS. +However it is recommend to check if you don't have a listener installed on SIGPIPE in your project before you use `rnr` library. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 1a0a276..e6c4800 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,16 +1,5 @@ { "name": "runtime-node-refresh", - "version": "1.0.1", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "name": "runtime-node-refresh", - "version": "1.0.1", - "license": "ISC", - "bin": { - "runtime-node-refresh": "bin/rnr.js" - } - } - } + "version": "1.0.6", + "lockfileVersion": 1 } diff --git a/package.json b/package.json index a372275..76ebaa4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "runtime-node-refresh", - "version": "1.0.5", + "version": "1.0.6", "bin": "./bin/rnr.js", "description": "Refresh node environment variables on runtime without restarting the node server.", "main": "index.js", @@ -15,6 +15,7 @@ "refresh envs", "update env", "runtime node refresh", + "change node envs", "changing log level at runtime", "update env", "update node envs"