more cleanups

Signed-off-by: Jeff Carr <[email protected]>

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2a5af4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+This is an abstraction layer around the excellent
+cross platform UI toolkit from andlabs/ui
+
+This abstraction layer makes it easier to write
+simple interfaces for like our cloud control panel
+
+The cross platform UI has 'quirks' due to it being
+cross platform. Some of the abstraction layer here
+attemps to obfuscate the ui objects so that it is
+more difficult to trigger inconsistancies.
+
+In this regard, this is an attempt to restrict
+all andlabs/ui (and andlabs/libui) interaction to
+the calls within this library.