Skip to content

Commit

Permalink
doc(README): recommend require as punycode.js
Browse files Browse the repository at this point in the history
  • Loading branch information
msimerson committed Mar 27, 2024
1 parent 9e1b2cd commit 8966bbd
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8966bbd

Please sign in to comment.