From a1afd2dbfcdf05dd6e2510f229853b65e5915284 Mon Sep 17 00:00:00 2001 From: jaywcjlove <398188662@qq.com> Date: Thu, 14 Apr 2022 23:21:32 +0800 Subject: [PATCH] doc: Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 3d4e801..2a4c6dd 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,20 @@ Convert image file to data URI. Support `.png`,`.gif`,`.jpg`,`.jpeg`,`.bm`,`.bmp ### Install +This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c): Node 12+ is needed to use it and it must be import instead of require. + ```bash npm i image2uri ``` +```js +const recursiveReaddirFiles = await import('image2uri'); + +// Fix compiling in typescript. +// https://github.com/microsoft/TypeScript/issues/43329#issuecomment-922544562 +const { getExt, recursiveReaddirFiles } = await (Function('return import("image2uri")')()) as Promise; +``` + ### Basic Usage ```js @@ -39,6 +49,20 @@ npm run build # compile .ts files. npm run start ``` +### Related + +- [recursive-readdir-files](https://github.com/jaywcjlove/recursive-readdir-files) Node.js module to list all files in a directory or any subdirectories. + +## Contributors + +As always, thanks to our amazing contributors! + + + + + +Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors). + ### License Licensed under the MIT License.