Skip to content

Commit 7dd1e06

Browse files
authored
add more to readme
1 parent ea1f289 commit 7dd1e06

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@
99
</div>
1010

1111
🏃‍♀️ Uses the native `node:punycode` module when using Node.js \
12-
📋 Delegates to the [punycode.js v2.0.1] implementation everywhere else \
12+
📋 Uses [punycode.js v2.0.1] everywhere else \
1313
⏳ Still prints the deprecation warning everywhere
1414

1515
🛑 **The `node:punycode` module is deprecated in Node.js core.** Instead, it's
16-
recommended to use a user-land implementation like [punycode.js]. This package
17-
is provided solely for parity with `node:` APIs.
16+
recommended to use a user-land implementation like [punycode.js] (which this
17+
package is based on). This package is provided solely for parity with `node:`
18+
APIs.
1819

1920
## Installation
2021

@@ -82,7 +83,7 @@ console.log(toUnicode("xn--wp8h"));
8283
Special thanks to [Mathias Bynens] for the [punycode.js v2.0.1] implementation!
8384
The code for the non-`node` targets is ripped straight from there (plus a
8485
warning message and explicit exports). As for types, you can thank TypeStrong
85-
and the DefinitelyTyped community for the `@types/node` definitions which,
86+
and the [DefinitelyTyped community] for the [`@types/node` definitions] which,
8687
again, are copy-pasted into the `index-types.d.ts` file.
8788

8889
There's no tests and no TypeScript since this package is simple enough to not
@@ -104,4 +105,6 @@ npm search results. 😎
104105
[the new `npm:` specifier]: https://deno.land/manual/node/npm_specifiers
105106
[esm.sh]: https://esm.sh/
106107
[jsdelivr]: https://www.jsdelivr.com/esm
108+
[definitelytyped community]: https://github.com/DefinitelyTyped/DefinitelyTyped
109+
[`@types/node` definitions]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node
107110
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)