Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Sep 20, 2021
1 parent 28ba6b3 commit 71f2547
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ const Jimp = require('jimp-compact')

See [jimp docs](https://github.com/oliver-moran/jimp/tree/master/packages/jimp) for full usage.

## Known Issues

In order to make typescript working, you need to (also) install `jimp` in `devDependencies`!
Track issue via [#39](https://github.com/unjs/jimp-compact/issues/39) and [#42](https://github.com/unjs/jimp-compact/issues/52).

## License

MIT - Based on [Jimp](https://github.com/oliver-moran/jimp/blob/master/LICENSE)

0 comments on commit 71f2547

Please sign in to comment.