1 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..5b3b408 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,71 @@
+# Converts BLP to PNG
+
+This tool converts images in BLP texture file format used in many games such as
+World of Warcraft into PNG files.
+
+It works with DXT1, DXT3 and DXT5 compressions so it should convert anything
+from WoW.
+
+It should work on all operating systems. There is no funky code in this
+repository or or any dependencies you need to have installed on your machine. C
+compiler and Libc is all you need.
+
+## Compile & Use
+
+```sh
+make -B
+```
+
+This will create `blpconvert` binary. Check available options with
+`./blpconvert -h`.
+
+Basic example of usage is `./blpconvert samples/Ability_Ambush.blp`.
+
+You can provide multiple input files or you can also use Bash expansion when
+providing files to the tool.
+
+```sh
+./blpconvert samples/*.blp
+```
+
+## Verbose output
+
+If you provide `-v` flag the program will output a bunch of diagnostical data.
+
+```sh
+$ ./blpconvert samples/Ability_Ambush.blp -v
+Processing File:
+  Fullname: samples/Ability_Ambush.blp
+  Folder: samples
+  Filename: Ability_Ambush
+  Extension: .blp
+BLP File Details:
+  Type: 1, BLP/DXTC/Uncompressed
+  Compression: 2, DXTC
+  Alpha Depth: 8
+  Alpha Type: 1
+  Has Mipmaps: 17
+  Width: 64, Height: 64
+Reading image data at offset 1172, size 4096 bytes
+BLP is compressed with DXTC.
+Image has 4096 bytes.
+Saving decoded image as PNG...
+Successfully saved samples/Ability_Ambush.png
+
+First few pixels of decoded image (RGBA format):
+(  0,  0,  0,  0) (  0,  0,  0,  0) (  0,  0,  0,  0) (  0,  0,  0,  0)
+(  0,  0,  0,  0) (  0,  0,  0,  0) (  0,  0,  0,  0) (  0,  0,  0,  0)
+(  0,  0,  0,  0) (  0,  0,  0,  0) (  0,  0,  0, 51) (184,200,200,221)
+(  0,  0,  0,  0) (  0,  0,  0,  0) (184,200,200,221) (184,200,200,255)
+```
+
+## Reading material
+
+- https://wowwiki-archive.fandom.com/wiki/BLP_file
+- https://en.wikipedia.org/wiki/S3_Texture_Compression
+
+## License
+
+[blpconvert](https://github.com/mitjafelicijan/blpconvert) was written by [Mitja
+Felicijan](https://mitjafelicijan.com) and is released under the BSD
+two-clause license, see the LICENSE file for more information.