From d05c43904fc48b51d6a3aba5cb3beb3dc5d6ed8a Mon Sep 17 00:00:00 2001 From: "kts of kettek (Gliese)" <kettek1@kettek.net> Date: Wed, 23 Jan 2019 18:20:54 -0800 Subject: [PATCH] Update README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64e736d..d968bf1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # png-js This is a modified version of [png.js](https://github.com/react-pdf/png.js) that is intended to be used for palette swapping within the browser. +**NOTE**: Only supports indexed PNGs for obvious reasons. All others will cause IndexedPNG to throw during construction. + ## Usage The following shows the process of loading a PNG file and rendering it to a canvas with its palette data reversed. @@ -94,4 +96,4 @@ let clip = { w: 32, h: 32, } -``` \ No newline at end of file +```