From 8966bbd218e7e8666f37de90bb42d3680a04df2a Mon Sep 17 00:00:00 2001 From: Matt Simerson Date: Tue, 26 Mar 2024 18:58:54 -0700 Subject: [PATCH] doc(README): recommend require as punycode.js fixes #122 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f611016..bdff028 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,17 @@ This project provides a CommonJS module that uses ES2015+ features and JavaScrip Via [npm](https://www.npmjs.com/): ```bash -npm install punycode --save +npm install punycode.js --save ``` In [Node.js](https://nodejs.org/): +```js +const punycode = require('punycode.js'); +``` + +### Legacy / Deprecated Usage + > ⚠️ Note that userland modules don't hide core modules. > For example, `require('punycode')` still imports the deprecated core module even if you executed `npm install punycode`. > Use `require('punycode/')` to import userland modules rather than core modules.