Added README.md

2017-05-28 04:42:58 +02:00 · 2017-05-28 04:42:58 +02:00 · 4212c21a1b
parent 8a28d6945a
commit 4212c21a1b
1 changed files with 8 additions and 0 deletions
--- a/README.md
+++ 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.