From f6d1dcb40718273aa58585ffa964aa0fd30bdfe9 Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 10 Aug 2023 21:27:23 +0900 Subject: [PATCH] describe usage with TypeScript --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40387b5..e78652e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ remark-emoji [![CI][ci-badge]][ci] [![npm][npm-badge]][npm] -This is a [remark](https://github.com/remarkjs/remark) plugin to replace `:emoji:` to real UTF-8 emojis in text. -Accessibility support and Emoticon support are optionally available. +[remark-emoji][npm] is a [remark](https://github.com/remarkjs/remark) plugin to replace `:emoji:` to real UTF-8 +emojis in text. Accessibility support and Emoticon support are optionally available. ## Demo @@ -80,6 +80,15 @@ Default value is `false`. Setting to `true` means that [emoticon](https://www.npmjs.com/package/emoticon) shortcodes are supported (e.g. :-) will be replaced by 😃). Default value is `false`. +## TypeScript support + +remark-emoji package contains [TypeScript](https://www.typescriptlang.org/) type definitions. The package is ready +for use with TypeScript. + +Note that the legacy `node` (or `node10`) resolution at [`moduleResolution`](https://www.typescriptlang.org/tsconfig#moduleResolution) +is not available since it enforces CommonJS module resolution and this package is ESM only. Please use `node16`, +`bundler`, or `nodenext` to enable ESM module resolution. + ## License Distributed under [the MIT License](LICENSE).