docs(examples): update readme

thi-ng · Sep 13, 2018 · 2b16d24 · 2b16d24
1 parent 2fa4c56
commit 2b16d24
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/examples/hdom-canvas-shapes/README.md b/examples/hdom-canvas-shapes/README.md
@@ -2,6 +2,17 @@
 
 [Live demo](http://demo.thi.ng/umbrella/hdom-canvas-shapes/)
 
+This example demonstrates different features of the still unreleased
+[@thi.ng/hdom-canvas](https://github.com/thi-ng/umbrella/tree/master/packages/hdom-canvas)
+package to declare canvas scenegraphs using the same hiccup syntax as
+the rest of the UI. These shape elements (children of the `canvas`
+component) are defined via a SVG-like approach and, using the
+branch-local behavior feature of
+[@thi.ng/hdom](https://github.com/thi-ng/umbrella/tree/master/packages/hdom),
+are translated into canvas API draw calls. Shapes can be grouped and any
+attributes defined on group nodes will be inherited by all children
+(same as in SVG).
+
 ```bash
 git clone https://github.com/thi-ng/umbrella.git
 cd umbrella/examples/hdom-canvas-shapes