From 4212c21a1b698ffdfb05b15581dba8a6f71d7bab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Christian=20Gr=C3=BCnhage?= <me@jcg.re>
Date: Sun, 28 May 2017 04:42:58 +0200
Subject: [PATCH] Added README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99addac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# pixclient - A golang Pixelflut client library
+
+This library implements basic (inperformant) API calls, for sending single pixels, whole images via "PX" and "SIZE" commands.
+
+Currently, it only writes stuff once. Possible further improvements:
+ - Cache PX commands and resend them
+ - When that is done, chunk the image, and send with one thread per chunk.
+ - When that is done, implement filtering, so that old PX commands are overridden by new ones.