From 4d1963062fb60db076adf6768311a77a56c9bb5c Mon Sep 17 00:00:00 2001
From: Daniel Bulant <danbulant@gmail.com>
Date: Thu, 26 Oct 2023 13:40:11 +0200
Subject: [PATCH] basic readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3110f7e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Mangui
+
+Experimental GUI framework, inspired by DOM.
+
+## Features
+
+- uses Taffy for layouts - Grid and Flexbox support
+- uses Femtovg as a renderer
+  - currently runs on OpenGL (and OpenGL ES) only - no M1 support yet
+  - no stroke dashing, custom shaders, 3d transforms or color fonts
+    - stroke dashing could possibly be done using stroke pattern
+- uses winit+glutin for window rendering
+- events mirror their DOM counterparts (names, bubbling etc).
+  - No capture part
+  - Properties are changed for better usability
+  - no currentTarget
+  - no stopping propagation
+  - no preventDefault as there are no default actions
+- no layers support (yet :))
+
+## Usage
+
+Similar to DOM, there are Nodes, which are recursive. They implement a Node trait, which only requires to get styles (for layouting with Taffy), children and a draw function.