docs: update readmes

- add screenshots to example readmes
erik-krogh · Feb 20, 2021 · 398cbb9 · 398cbb9
1 parent c1efcf1
commit 398cbb9
Show file tree

Hide file tree

Showing 80 changed files with 170 additions and 33 deletions.
diff --git a/examples/adaptive-threshold/README.md b/examples/adaptive-threshold/README.md
@@ -1,5 +1,7 @@
 # adaptive-threshold
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/adaptive-threshold.png)
+
 [Live demo](http://demo.thi.ng/umbrella/adaptive-threshold/)
 
 Image processing via

diff --git a/examples/bitmap-font/README.md b/examples/bitmap-font/README.md
@@ -1,5 +1,7 @@
 # bitmap-font
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/bitmap-font.gif)
+
 [Live demo](http://demo.thi.ng/umbrella/bitmap-font/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/canvas-dial/README.md b/examples/canvas-dial/README.md
@@ -1,5 +1,7 @@
 # canvas-dial
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/canvas-dial.png)
+
 [Live demo](http://demo.thi.ng/umbrella/canvas-dial/)
 
 Customizable canvas-based radial dial component with mouse & touch

diff --git a/examples/cellular-automata/README.md b/examples/cellular-automata/README.md
@@ -1,5 +1,7 @@
 # Cellular automata
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/cellular-automata.png)
+
 [Live demo](https://demo.thi.ng/umbrella/cellular-automata/)
 
 Please refer to the [example build

diff --git a/examples/commit-heatmap/README.md b/examples/commit-heatmap/README.md
@@ -1,6 +1,6 @@
 # commit-heatmap
 
-![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/commit-heatmap.png)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/commit-heatmap.png)
 
 This is offline example creates a heatmap visualization of per-package
 commits in this mono-repo, but could also be used for other mono-repos

diff --git a/examples/commit-table-ssr/README.md b/examples/commit-table-ssr/README.md
@@ -1,5 +1,7 @@
 # commit-table-ssr
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/commit-table-ssr.png)
+
 [Live version](http://demo.thi.ng/umbrella/commit-table-ssr/)
 
 This example demonstrates isomorphic,

diff --git a/examples/crypto-chart/README.md b/examples/crypto-chart/README.md
@@ -1,8 +1,8 @@
 # crypto-chart
 
-[Live demo](https://s3.amazonaws.com/demo.thi.ng/umbrella/crypto-chart/index.html)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/crypto-chart.png)
 
-![chart](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/crypto-chart.png)
+[Live demo](https://s3.amazonaws.com/demo.thi.ng/umbrella/crypto-chart/index.html)
 
 Price data provided by [cryptocompare.com](https://min-api.cryptocompare.com/).
 

diff --git a/examples/ellipse-proximity/README.md b/examples/ellipse-proximity/README.md
@@ -1,5 +1,7 @@
 # ellipse-proximity
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ellipse-proximity.png)
+
 [Live demo](http://demo.thi.ng/umbrella/ellipse-proximity/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/fft-synth/README.md b/examples/fft-synth/README.md
@@ -1,6 +1,6 @@
 # fft-synth
 
-![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/fft-synth.png)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fft-synth.png)
 
 [Live demo](http://demo.thi.ng/umbrella/fft-synth/)
 

diff --git a/examples/geom-convex-hull/README.md b/examples/geom-convex-hull/README.md
@@ -1,5 +1,7 @@
 # geom-convex-hull
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/geom-convex-hull.png)
+
 [Live demo](http://demo.thi.ng/umbrella/geom-convex-hull/)
 
 A refactored version of a [blog post code example by Pete

diff --git a/examples/geom-fuzz-basics/README.md b/examples/geom-fuzz-basics/README.md
@@ -1,5 +1,7 @@
 # geom-fuzz-basics
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom/geom-fuzz.png)
+
 [Live demo](http://demo.thi.ng/umbrella/geom-fuzz-basics/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/geom-knn/README.md b/examples/geom-knn/README.md
@@ -1,5 +1,7 @@
 # geom-knn
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/geom-knn.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/geom-knn/)
 
 Drawing / debug toy based on 2x recursive KNN search using the k-D tree

diff --git a/examples/geom-tessel/README.md b/examples/geom-tessel/README.md
@@ -1,5 +1,7 @@
 # geom-tessel
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom/tessel.png)
+
 [Live demo](http://demo.thi.ng/umbrella/geom-tessel/)
 
 Test example of

diff --git a/examples/geom-voronoi-mst/README.md b/examples/geom-voronoi-mst/README.md
@@ -1,5 +1,7 @@
 # geom-voronoi-mst
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/geom-voronoi-mst.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/geom-voronoi-mst/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/gesture-analysis/README.md b/examples/gesture-analysis/README.md
@@ -1,5 +1,7 @@
 # gesture-analysis
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/gesture-analysis.png)
+
 [Live demo](http://demo.thi.ng/umbrella/gesture-analysis/)
 
 Mouse / touch gesture processing, analysis and SVG visualization, using

diff --git a/examples/grid-iterators/README.md b/examples/grid-iterators/README.md
@@ -1,5 +1,7 @@
 # grid-iterators
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/grid-iterators.png)
+
 [Live demo](http://demo.thi.ng/umbrella/grid-iterators/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/hdom-benchmark/README.md b/examples/hdom-benchmark/README.md
@@ -1,5 +1,7 @@
 # hdom-benchmark
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-benchmark.png)
+
 [Live demo](https://demo.thi.ng/umbrella/hdom-benchmark/)
 
 Please refer to the [example build

diff --git a/examples/hdom-benchmark2/README.md b/examples/hdom-benchmark2/README.md
@@ -1,5 +1,7 @@
 # hdom-benchmark2
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-benchmark2.png)
+
 [Live demo](http://demo.thi.ng/umbrella/hdom-benchmark2/)
 
 Please refer to the [example build

diff --git a/examples/hdom-canvas-clock/README.md b/examples/hdom-canvas-clock/README.md
@@ -1,5 +1,7 @@
 # hdom-canvas-clock
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-canvas-clock.png)
+
 [Live demo](http://demo.thi.ng/umbrella/hdom-canvas-clock/)
 
 Declarative canvas drawing using the

diff --git a/examples/hdom-canvas-draw/README.md b/examples/hdom-canvas-draw/README.md
@@ -1,5 +1,7 @@
 # hdom-canvas-draw
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-canvas-draw.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/hdom-canvas-draw/)
 
 Please refer to the [example build

diff --git a/examples/hdom-canvas-particles/README.md b/examples/hdom-canvas-particles/README.md
@@ -1,5 +1,7 @@
 # hdom-canvas-particles
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-canvas-particles.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/hdom-canvas-particles/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/hdom-canvas-shapes/README.md b/examples/hdom-canvas-shapes/README.md
@@ -1,6 +1,6 @@
 # hdom-canvas-shapes
 
-![screenshots](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/hdom-canvas/hdom-canvas-shapes-results.png)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/hdom-canvas/hdom-canvas-shapes-results.png)
 
 [Live demo](http://demo.thi.ng/umbrella/hdom-canvas-shapes/)
 

diff --git a/examples/hdom-toggle/README.md b/examples/hdom-toggle/README.md
@@ -1,5 +1,7 @@
 # hdom-toggle
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-toggle.png)
+
 [Live demo](http://demo.thi.ng/umbrella/hdom-toggle/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/hiccup-canvas-arcs/README.md b/examples/hiccup-canvas-arcs/README.md
@@ -1,5 +1,7 @@
 # hiccup-canvas-arcs
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hiccup-canvas-arcs.png)
+
 [Live demo](http://demo.thi.ng/umbrella/hiccup-canvas-arcs/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/imgui-basics/README.md b/examples/imgui-basics/README.md
@@ -1,5 +1,7 @@
 # imgui-basics
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/imgui-basics.png)
+
 [Live demo](http://demo.thi.ng/umbrella/imgui-basics/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/imgui/README.md b/examples/imgui/README.md
@@ -1,6 +1,6 @@
 # imgui
 
-![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/imgui/imgui-all.png)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/imgui/imgui-all.png)
 
 [Live demo](http://demo.thi.ng/umbrella/imgui/)
 

diff --git a/examples/iso-plasma/README.md b/examples/iso-plasma/README.md
@@ -1,5 +1,7 @@
 # iso-plasma
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom/geom-isoline.png)
+
 [Live demo](http://demo.thi.ng/umbrella/iso-plasma/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/json-components/README.md b/examples/json-components/README.md
@@ -1,5 +1,7 @@
 # json-components
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/json-components.jpg)
+
 [Live demo](https://demo.thi.ng/umbrella/json-components/)
 
 Please refer to the [example build

diff --git a/examples/mandelbrot/README.md b/examples/mandelbrot/README.md
@@ -1,5 +1,7 @@
 # mandelbrot
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/mandelbrot.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/mandelbrot/)
 
 Please refer to the [example build

diff --git a/examples/markdown/README.md b/examples/markdown/README.md
@@ -1,5 +1,7 @@
 # Minimal Markdown parser
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/markdown-parser.jpg)
+
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
 
@@ -91,6 +93,8 @@ import { parse } from "@thi.ng/hiccup-markdown";
 const src = `
 # Hello world
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/Hello world.png)
+
 [This](http://example.com) is a _test_.
 
 `;

diff --git a/examples/parse-playground/README.md b/examples/parse-playground/README.md
@@ -1,5 +1,7 @@
 # parse-playground
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/parse-playground.png)
+
 [Visit playground](http://demo.thi.ng/umbrella/parse-playground/)
 
 This project was largely created during the very first [thi.ng/umbrella

diff --git a/examples/pixel-basics/README.md b/examples/pixel-basics/README.md
@@ -1,8 +1,8 @@
 # pixel-basics
 
-[Live demo](http://demo.thi.ng/umbrella/pixel-basics/)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/pixel/pixel-basics.png)
 
-![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/pixel/pixel-basics.png)
+[Live demo](http://demo.thi.ng/umbrella/pixel-basics/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.
 

diff --git a/examples/pixel-sorting/README.md b/examples/pixel-sorting/README.md
@@ -1,5 +1,7 @@
 # pixel-sorting
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/pixel-sorting.png)
+
 [Live demo](http://demo.thi.ng/umbrella/pixel-sorting/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/pointfree-svg/README.md b/examples/pointfree-svg/README.md
@@ -1,15 +1,15 @@
 # pointfree-svg
 
-This is a non-browser demo combining the following packages to generate
-the SVG graphic below:
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/pointfree-svg.png)
+
+This is a non-browser demo combining the following packages to generate the
+above SVG graphic:
 
 - [@thi.ng/hiccup](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup)
 - [@thi.ng/hiccup-svg](https://github.com/thi-ng/umbrella/tree/develop/packages/hiccup-svg)
 - [@thi.ng/pointfree](https://github.com/thi-ng/umbrella/tree/develop/packages/pointfree)
 - [@thi.ng/pointfree-lang](https://github.com/thi-ng/umbrella/tree/develop/packages/pointfree-lang)
 
-![generated result](https://raw.githubusercontent.com/thi-ng/umbrella/master/examples/pointfree-svg/output.svg)
-
 Most of the [source
 code](https://raw.githubusercontent.com/thi-ng/umbrella/master/examples/pointfree-svg/src/index.ts)
 is written in the pointfree DSL syntax and includes a rudimentary

diff --git a/examples/poisson-circles/README.md b/examples/poisson-circles/README.md
@@ -1,5 +1,7 @@
 # poisson-circles
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/poisson/poisson.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/poisson-circles/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/poly-spline/README.md b/examples/poly-spline/README.md
@@ -1,5 +1,7 @@
 # poly-spline
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/poly-spline.png)
+
 [Live demo](http://demo.thi.ng/umbrella/poly-spline/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/porter-duff/README.md b/examples/porter-duff/README.md
@@ -1,5 +1,7 @@
 # porter-duff
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/porter-duff/porter-duff2.png)
+
 [Live demo](http://demo.thi.ng/umbrella/porter-duff/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/ramp-synth/README.md b/examples/ramp-synth/README.md
@@ -1,6 +1,6 @@
 # ramp-synth
 
-![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/ramp-synth.png)
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/ramp-synth.png)
 
 [Live demo](http://demo.thi.ng/umbrella/ramp-synth/)
 

diff --git a/examples/rdom-dnd/README.md b/examples/rdom-dnd/README.md
@@ -1,5 +1,7 @@
 # rdom-dnd
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rdom-dnd.png)
+
 [Live demo](http://demo.thi.ng/umbrella/rdom-dnd/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/rdom-lissajous/README.md b/examples/rdom-lissajous/README.md
@@ -1,5 +1,7 @@
 # rdom-lissajous
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rdom-lissajous.png)
+
 [Live demo](http://demo.thi.ng/umbrella/rdom-lissajous/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/rdom-svg-nodes/README.md b/examples/rdom-svg-nodes/README.md
@@ -1,5 +1,7 @@
 # rdom-svg-nodes
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rdom-svg-nodes.png)
+
 [Live demo](http://demo.thi.ng/umbrella/rdom-svg-nodes/)
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.

diff --git a/examples/rotating-voronoi/README.md b/examples/rotating-voronoi/README.md
@@ -1,5 +1,7 @@
 # rotating-voronoi
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rotating-voronoi.jpg)
+
 [Live demo](http://demo.thi.ng/umbrella/rotating-voronoi/)
 
 Example to show 2d spline in combination with voronoi tessellation.
@@ -9,7 +11,7 @@ Please refer to the [example build instructions](https://github.com/thi-ng/umbre
 
 ## Authors
 
--   Alberto Massa
+- Alberto Massa
 
 ## License
 

diff --git a/examples/router-basics/README.md b/examples/router-basics/README.md
@@ -1,5 +1,7 @@
 # router-basics
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/router-basics.jpg)
+
 [Live demo](https://demo.thi.ng/umbrella/router-basics/)
 
 Please refer to the [example build

diff --git a/examples/rstream-event-loop/README.md b/examples/rstream-event-loop/README.md
@@ -1,13 +1,13 @@
 # rstream-event-loop
 
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rstream-event-loop.png)
+
 [Live demo](http://demo.thi.ng/umbrella/rstream-event-loop/)
 
 This example demonstrates the use of
 [@thi.ng/rstream](https://github.com/thi-ng/umbrella/tree/develop/packages/rstream)
 constructs to define a basic event-loop, event handlers and reactive DOM
-updates, based on the dataflow topology shown below:
-
-![generated result](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/rstream-event-loop.png)
+updates, based on the dataflow topology shown above.
 
 Please refer to the [example build instructions](https://github.com/thi-ng/umbrella/wiki/Example-build-instructions) on the wiki.