From 348712d44ebc23a8c7393cff38694dc5800511ea Mon Sep 17 00:00:00 2001 From: James <5511220+Zamiell@users.noreply.github.com> Date: Tue, 19 Dec 2023 13:38:39 -0500 Subject: [PATCH] Update README.md --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 60a80d4c4..017d78aa1 100644 --- a/README.md +++ b/README.md @@ -69,10 +69,11 @@ binaries are available for the most popular platforms, so you don't necessarily need to have a C++ compiler installed on your machine. To force `ws` to not use `bufferutil`, use the -[`WS_NO_BUFFER_UTIL`](./doc/ws.md#ws_no_buffer_util) environment variable. This -can be useful to enhance security in systems where a user can put a package in -the package search path of an application of another user, due to how the Node.js -resolver algorithm works. +[`WS_NO_BUFFER_UTIL`](./doc/ws.md#ws_no_buffer_util) environment variable. If +this is set, `require()` will not be called. This can be useful to enhance +security in systems where a user can put a package in the package search path +of an application of another user, due to how the Node.js resolver algorithm +works. #### Legacy opt-in for performance @@ -86,7 +87,8 @@ npm install --save-optional utf-8-validate This contains a binary polyfill for [`buffer.isUtf8()`][]. To force `ws` to not use `bufferutil`, use the -[`WS_NO_UTF_8_VALIDATE`]((./doc/ws.md#ws_no_utf_8_validate) environment variable. +[`WS_NO_UTF_8_VALIDATE`]((./doc/ws.md#ws_no_utf_8_validate) environment variable. If +this is set, `require()` will not be called. ## API docs