From 964429c5755a83d3565d4729e1c7f41170e77b1a Mon Sep 17 00:00:00 2001
From: Clement Sibille <clements+git@lisible.xyz>
Date: Tue, 5 Mar 2024 16:59:28 +0900
Subject: Add documentation

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6eb528e..dad2d43 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
 # LisiblePNG - a PNG decoder
 
 This PNG decoder is meant to be used in my other C projects.
+
+## Supported features
+
+This is a simple implementation of a PNG decoder, it currently implements the following features:
+- Greyscale wihout alpha
+- Truecolour without alpha, without palette
+- 1 to 16 bit depth samples
+- All PNG filtering methods
+
+## Building
+
+```bash 
+meson setup <builddir>
+meson compile -C <builddir>
+```
-- 
cgit v1.2.3