From e8d88b9088464574f045e995327aca886913f33d Mon Sep 17 00:00:00 2001
From: DrNuget <drnuget@outlook.com>
Date: Sun, 2 Nov 2025 16:23:45 +0200
Subject: add README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3def5ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Brailleboi - the best braille image plotting library written in C
+---
+## Current list of features:
+- Variable size image buffer
+- X,Y plotting of dots
+## Example code:
+```
+#include "src/brailleboi.h"
+
+int main()
+{
+	image_buffer buf;
+	brailleInit(200, 200, &buf);
+	for (int i=0;i<buf.width;i++) {
+		braillePlot(i, i, &buf);
+	}
+	brailleUpdateScreen(&buf);
+	brailleStop(&buf);
+	return 0;
+}
+```
-- 
cgit v1.2.3