Docs

Signed-off-by: Slendi <slendi@socopon.com>

README.md

@@ -0,0 +1,24 @@
+BitFLip image format
+====================
+
+BFL is an image format for storing compressed or uncompressed 1 bit per pixel
+images.
+
+Format features:
+- Transparency support
+- Relatively simple to implement, compression can be omitted completely
+- Lossless compression
+- Usually smaller than PNG
+
+Library features:
+- No external dependencies
+- Written in C++20
+- Full compression support
+- Compression on encoding can be disabled
+
+License
+-------
+
+This software is licensed under the GNU GPLv3 license. Check
+[LICENSE](LICENSE.rst) for more information.
+