diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 271ac9d5f..71e0af24c 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -8,6 +8,7 @@ on: jobs: nodejs: + # Documentation: https://github.com/zakodium/workflows#nodejs-ci uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1 with: lint-check-types: true diff --git a/.ncurc.yml b/.ncurc.yml index 22d8cdf50..a694d3c4d 100644 --- a/.ncurc.yml +++ b/.ncurc.yml @@ -1,3 +1,3 @@ reject: - # Package is now ESM-only + # Package is now asynchronous - 'image-type' diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 000000000..1b763b1ba --- /dev/null +++ b/.prettierignore @@ -0,0 +1 @@ +CHANGELOG.md diff --git a/README.md b/README.md index 147db2132..a887525bd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,32 @@ +

+ + Zakodium logo + +

+ Maintained by Zakodium +

+

+ # image-js -[![NPM version][npm-image]][npm-url] -[![build status][ci-image]][ci-url] -[![Test coverage][codecov-image]][codecov-url] -[![npm download][download-image]][download-url] +[![NPM version](https://img.shields.io/npm/v/image-js.svg)](https://www.npmjs.com/package/image-js) +[![npm download](https://img.shields.io/npm/dm/image-js.svg)](https://www.npmjs.com/package/image-js) +[![test coverage](https://img.shields.io/codecov/c/github/image-js-typescript/image-js-typescript.svg)](https://codecov.io/gh/image-js/image-js-typescript) +[![license](https://img.shields.io/npm/l/image-js.svg)](https://github.com/image-js/image-js-typescript/blob/main/LICENSE) Image processing and manipulation in JavaScript. ## Installation -`$ npm i image-js` +```console +npm install image-js +``` + +## API -## [API](https://image-js.github.io/image-js-typescript/) +### [Complete API documentation](https://image-js.github.io/image-js-typescript/) + +### [Usage docs and guides](https://image-js-docs.pages.dev/docs/Getting%20started) ## Development @@ -20,12 +35,3 @@ See [Development documentation](./Development.md). ## License [MIT](./LICENSE) - -[npm-image]: https://img.shields.io/npm/v/image-js.svg -[npm-url]: https://www.npmjs.com/package/image-js -[ci-image]: https://github.com/image-js/image-js-typescript/actions/workflows/nodejs.yml/badge.svg -[ci-url]: https://github.com/image-js/image-js-typescript/actions/workflows/nodejs.yml -[codecov-image]: https://img.shields.io/codecov/c/github/image-js/image-js-typescript.svg -[codecov-url]: https://codecov.io/gh/image-js/image-js-typescript -[download-image]: https://img.shields.io/npm/dm/image-js.svg -[download-url]: https://www.npmjs.com/package/image-js diff --git a/api-extractor.json b/api-extractor.json index 97c50b60d..da652662f 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -103,7 +103,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/tsconfig.json" */ - "tsconfigFilePath": "/tsconfig.esm.json" + "tsconfigFilePath": "/tsconfig.build.json" /** * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. * The object must conform to the TypeScript tsconfig schema: diff --git a/demo/.eslintrc.yml b/demo/.eslintrc.yml deleted file mode 100644 index e69de29bb..000000000 diff --git a/demo/components/CameraSelector.tsx b/demo/components/CameraSelector.tsx index 1ced9d719..60888b619 100644 --- a/demo/components/CameraSelector.tsx +++ b/demo/components/CameraSelector.tsx @@ -14,7 +14,7 @@ export default function CameraSelector() {