add README

1 files changed, 21 insertions, 0 deletions

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;
+}
+```