Skip to content

Commit

Permalink
chore: update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
iamriajul committed Oct 31, 2023
1 parent 030ce33 commit 8287fef
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Thumbhash is a compact representation of a placeholder for an image.

![screenshot](screenshot.png)

<p align="center">Nr8%YLkDR4j[aej]NSaznzjuk9ayR3jYofayj[f6</p>
<p align="center">XFYJhIooaHh6d3hweYuHgHoJmA</p>

⚠️ I highly recommend to have Imagick extension installed on your computer. GD extension has only 7 bits of alpha channel resolution, and 127 is transparent, 0 opaque. While the library will still work, you may have different image between platforms. [See on stackoverflow](https://stackoverflow.com/questions/41079110/is-it-possible-to-retrieve-the-alpha-value-of-a-pixel-of-a-png-file-in-the-0-255)

Expand Down Expand Up @@ -54,6 +54,13 @@ app('thumbhash')
->encode(request('file'));
```

### TODO:
- [x] Support encoding to thumbhash base64 string.
- [ ] Support decoding from thumbhash base64 string.
- [ ] Support encoding to thumbhash binary array.
- [ ] Support decoding from thumbhash binary array.
- [ ] Support encoding to dataURL.

## License

Thumbhash is licensed under [The MIT License (MIT).](LICENSE.md)
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8287fef

Please sign in to comment.