Skip to content

Commit

Permalink
updating readme with browser information
Browse files Browse the repository at this point in the history
  • Loading branch information
catdad committed Nov 29, 2023
1 parent 4bc3851 commit cef9b94
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
npm install heic-convert
```

## Usage
## Usage in NodeJS

Convert the main image in a HEIC to JPEG

Expand Down Expand Up @@ -83,6 +83,18 @@ The work to convert an image is done when calling `image.convert()`, so if you o

_Note that while the converter returns a Promise and is overall asynchronous, a lot of work is still done synchronously, so you should consider using a worker thread in order to not block the main thread in highly concurrent production environments._

## Usage in the browser

While the NodeJS version of `heic-convert` may be compiled for use in the browser with something like `webpack`, [not all build tools necessarily like to compile all modules well](https://github.com/catdad-experiments/heic-convert/issues/29). However, what further complicates things is that this module uses pure-javascript implementations of a jpeg and png encoder. But the browser has its own native encoders! Let's just use those.

When compiling a client-side project, use:

```javascript
const convert = require('heic-convert/browser');
```

This is currently only supported in the main thread. Support for workers may be added in the future, but if you need it sooner, please create an issue or even a PR!

## Related

* [heic-cli](https://github.com/catdad-experiments/heic-cli) - convert heic/heif images to jpeg or png from the command line
Expand Down

0 comments on commit cef9b94

Please sign in to comment.