docs(examples): update readme, add pkg meta/screenshots

erik-krogh · Mar 1, 2020 · 4247081 · 4247081
1 parent c75f18c
commit 4247081
Show file tree

Hide file tree

Showing 20 changed files with 40 additions and 18 deletions.
diff --git a/assets/examples/hdom-benchmark.png b/assets/examples/hdom-benchmark.png
diff --git a/assets/examples/json-components.jpg b/assets/examples/json-components.jpg
diff --git a/assets/examples/router-basics.jpg b/assets/examples/router-basics.jpg
diff --git a/assets/examples/shader-ast-noise.jpg b/assets/examples/shader-ast-noise.jpg
diff --git a/assets/examples/shader-ast-tunnel.jpg b/assets/examples/shader-ast-tunnel.jpg
diff --git a/assets/examples/talk-slides.png b/assets/examples/talk-slides.png
diff --git a/assets/examples/todo-list.png b/assets/examples/todo-list.png
diff --git a/assets/examples/triple-query.png b/assets/examples/triple-query.png
diff --git a/assets/examples/webgl-cube.png b/assets/examples/webgl-cube.png
diff --git a/examples/README.md b/examples/README.md
@@ -27,7 +27,7 @@ in touch via PR, issue tracker, email or twitter!
 | 015 | <img src="../assets/examples/gesture-analysis.png" width="240"/>              | [gesture-analysis](./gesture-analysis/)           | Mouse gesture / stroke analysis, simplification, corner detection                |
 | 016 | <img src="../assets/examples/grid-iterators.png" width="240"/>                | [grid-iterators](./grid-iterators/)               | Visualization of different grid iterator strategies                              |
 | 017 |                                                                               | [hdom-basics](./hdom-basics/)                     | Minimal hdom usage example                                                       |
-| 018 |                                                                               | [hdom-benchmark](./hdom-benchmark/)               | hdom update performance benchmark (old version)                                  |
+| 018 | <img src="../assets/examples/hdom-benchmark.png" width="240"/>                | [hdom-benchmark](./hdom-benchmark/)               | hdom update performance benchmark (old version)                                  |
 | 019 | <img src="../assets/examples/hdom-benchmark2.png" width="240"/>               | [hdom-benchmark2](./hdom-benchmark2/)             | hdom update performance benchmark w/ config options                              |
 | 020 | <img src="../assets/examples/hdom-canvas-clock.png" width="240"/>             | [hdom-canvas-clock](./hdom-canvas-clock/)         | Realtime analog clock demo                                                       |
 | 021 | <img src="../assets/examples/hdom-canvas-draw.jpg" width="240"/>              | [hdom-canvas-draw](./hdom-canvas-draw/)           | Interactive pattern drawing demo using transducers                               |
@@ -50,7 +50,7 @@ in touch via PR, issue tracker, email or twitter!
 | 038 |                                                                               | [interceptor-basics](./interceptor-basics/)       | Event handling w/ interceptors and side effects                                  |
 | 039 |                                                                               | [interceptor-basics2](./interceptor-basics2/)     | Event handling w/ interceptors and side effects                                  |
 | 040 | <img src="../assets/geom/geom-isoline.png" width="240"/>                      | [iso-plasma](./iso-plasma/)                       | Animated sine plasma effect visualized using contour lines                       |
-| 041 |                                                                               | [json-components](./json-components/)             | Transforming JSON into UI components                                             |
+| 041 | <img src="../assets/examples/json-components.jpg" width="240"/>               | [json-components](./json-components/)             | Transforming JSON into UI components                                             |
 | 042 |                                                                               | [login-form](./login-form/)                       | Basic SPA example without router                                                 |
 | 043 | <img src="../assets/examples/mandelbrot.jpg" width="240"/>                    | [mandelbrot](./mandelbrot/)                       | Worker based, interactive Mandelbrot visualization                               |
 | 044 | <img src="../assets/examples/markdown-parser.jpg" width="240"/>               | [markdown](./markdown/)                           | Minimal Markdown to Hiccup to HTML parser / transformer                          |
@@ -62,7 +62,7 @@ in touch via PR, issue tracker, email or twitter!
 | 050 | <img src="../assets/porter-duff/porter-duff2.png" width="240"/>               | [porter-duff](./porter-duff/)                     | Port-Duff image compositing / alpha blending                                     |
 | 051 | <img src="../assets/examples/ramp-synth.png" width="240"/>                    | [ramp-synth](./ramp-synth/)                       | Unison wavetable synth with waveform editor                                      |
 | 052 | <img src="../assets/examples/rotating-voronoi.jpg" width="240"/>              | [rotating-voronoi](./rotating-voronoi/)           | Animated Voronoi diagram, cubic splines & SVG download                           |
-| 053 |                                                                               | [router-basics](./router-basics/)                 | Complete mini SPA app w/ router & async content loading                          |
+| 053 | <img src="../assets/examples/router-basics.jpg" width="240"/>                 | [router-basics](./router-basics/)                 | Complete mini SPA app w/ router & async content loading                          |
 | 054 |                                                                               | [rstream-dataflow](./rstream-dataflow/)           | Minimal rstream dataflow graph                                                   |
 | 055 | <img src="../assets/examples/rstream-event-loop.png" width="240"/>            | [rstream-event-loop](./rstream-event-loop/)       | Minimal demo of using rstream constructs to form an interceptor-style event loop |
 | 056 | <img src="../assets/examples/rstream-grid.jpg" width="240"/>                  | [rstream-grid](./rstream-grid/)                   | Interactive grid generator, SVG generation & export, undo/redo support           |
@@ -72,21 +72,21 @@ in touch via PR, issue tracker, email or twitter!
 | 060 | <img src="../assets/examples/scenegraph-image.png" width="240"/>              | [scenegraph-image](./scenegraph-image/)           | 2D scenegraph & image map based geometry manipulation                            |
 | 061 | <img src="../assets/shader-ast/shader-ast-01.jpg" width="240"/>               | [shader-ast-canvas2d](./shader-ast-canvas2d/)     | 2D canvas shader emulation                                                       |
 | 062 | <img src="../assets/examples/shader-ast-evo.jpg" width="240"/>                | [shader-ast-evo](./shader-ast-evo/)               | Evolutionary shader generation using genetic programming                         |
-| 063 |                                                                               | [shader-ast-noise](./shader-ast-noise/)           | HOF shader procedural noise function composition                                 |
+| 063 | <img src="../assets/examples/shader-ast-noise.jpg" width="240"/>              | [shader-ast-noise](./shader-ast-noise/)           | HOF shader procedural noise function composition                                 |
 | 064 | <img src="../assets/shader-ast/shader-ast-raymarch.jpg" width="240"/>         | [shader-ast-raymarch](./shader-ast-raymarch/)     | WebGL & JS canvas2D raymarch shader cross-compilation                            |
 | 065 | <img src="../assets/examples/shader-ast-sdf2d.jpg" width="240"/>              | [shader-ast-sdf2d](./shader-ast-sdf2d/)           | WebGL & JS canvas 2D SDF                                                         |
-| 066 |                                                                               | [shader-ast-tunnel](./shader-ast-tunnel/)         | WebGL & Canvas2D textured tunnel shader                                          |
+| 066 | <img src="../assets/examples/shader-ast-tunnel.jpg" width="240"/>             | [shader-ast-tunnel](./shader-ast-tunnel/)         | WebGL & Canvas2D textured tunnel shader                                          |
 | 067 | <img src="../assets/examples/shader-ast-workers.jpg" width="240"/>            | [shader-ast-workers](./shader-ast-workers/)       | Fork-join worker-based raymarch renderer                                         |
 | 068 | <img src="../assets/examples/soa-ecs-100k.png" width="240"/>                  | [soa-ecs](./soa-ecs/)                             | Entity Component System w/ 100k 3D particles                                     |
-| 069 |                                                                               | [svg-barchart](./svg-barchart/)                   | Simplistic SVG bar chart component                                               |
+| 069 | <img src="../assets/examples/svg-barchart.png" width="240"/>                  | [svg-barchart](./svg-barchart/)                   | Simplistic SVG bar chart component                                               |
 | 070 |                                                                               | [svg-particles](./svg-particles/)                 | Basic 2D particle system w/ SVG shapes                                           |
 | 071 | <img src="../assets/examples/svg-waveform.jpg" width="240"/>                  | [svg-waveform](./svg-waveform/)                   | Additive waveform synthesis & SVG visualization with undo/redo                   |
-| 072 |                                                                               | [talk-slides](./talk-slides/)                     | Presentation slides from ClojureX 2018 keynote                                   |
+| 072 | <img src="../assets/examples/talk-slides.png" width="240"/>                   | [talk-slides](./talk-slides/)                     | hdom based slide deck viewer & slides from my ClojureX 2018 keynote              |
 | 073 | <img src="../assets/examples/text-canvas.png" width="240"/>                   | [text-canvas](./text-canvas/)                     | 3D wireframe textmode demo                                                       |
-| 074 |                                                                               | [todo-list](./todo-list/)                         | Obligatory to-do list example with undo/redo                                     |
+| 074 | <img src="../assets/examples/todo-list.png" width="240"/>                     | [todo-list](./todo-list/)                         | Obligatory to-do list example with undo/redo                                     |
 | 075 |                                                                               | [transducers-hdom](./transducers-hdom/)           | Transducer & rstream based hdom UI updates                                       |
-| 076 |                                                                               | [triple-query](./triple-query/)                   | Triple store query results & sortable table                                      |
-| 077 |                                                                               | [webgl-cube](./webgl-cube/)                       | WebGL multi-colored cube mesh                                                    |
+| 076 | <img src="../assets/examples/triple-query.png" width="240"/>                  | [triple-query](./triple-query/)                   | Triple store query results & sortable table                                      |
+| 077 | <img src="../assets/examples/webgl-cube.png" width="240"/>                    | [webgl-cube](./webgl-cube/)                       | WebGL multi-colored cube mesh                                                    |
 | 078 | <img src="../assets/examples/webgl-cubemap.jpg" width="240"/>                 | [webgl-cubemap](./webgl-cubemap/)                 | WebGL cube maps with async texture loading                                       |
 | 079 | <img src="../assets/examples/webgl-grid.jpg" width="240"/>                    | [webgl-grid](./webgl-grid/)                       | WebGL instancing, animated grid                                                  |
 | 080 | <img src="../assets/examples/webgl-msdf.jpg" width="240"/>                    | [webgl-msdf](./webgl-msdf/)                       | WebGL MSDF text rendering & particle system                                      |

diff --git a/examples/hdom-benchmark/package.json b/examples/hdom-benchmark/package.json
@@ -27,5 +27,8 @@
     ],
     "browser": {
         "process": false
+    },
+    "thi.ng": {
+        "screenshot": "examples/hdom-benchmark.png"
     }
 }
diff --git a/examples/json-components/package.json b/examples/json-components/package.json
@@ -24,5 +24,9 @@
     ],
     "browser": {
         "process": false
+    },
+    "thi.ng": {
+        "readme": true,
+        "screenshot": "examples/json-components.jpg"
     }
 }
diff --git a/examples/router-basics/package.json b/examples/router-basics/package.json
@@ -36,6 +36,7 @@
             "hdom",
             "interceptors",
             "router"
-        ]
+        ],
+        "screenshot": "examples/router-basics.jpg"
     }
 }
diff --git a/examples/shader-ast-noise/package.json b/examples/shader-ast-noise/package.json
@@ -30,6 +30,7 @@
         "process": false
     },
     "thi.ng": {
-        "readme": true
+        "readme": true,
+        "screenshot": "examples/shader-ast-noise.jpg"
     }
 }
diff --git a/examples/shader-ast-tunnel/package.json b/examples/shader-ast-tunnel/package.json
@@ -37,6 +37,7 @@
             "shader-ast-js",
             "shader-ast-stdlib",
             "webgl"
-        ]
+        ],
+        "screenshot": "examples/shader-ast-tunnel.jpg"
     }
 }
diff --git a/examples/svg-barchart/package.json b/examples/svg-barchart/package.json
@@ -27,6 +27,7 @@
         "process": false
     },
     "thi.ng": {
-        "readme": true
+        "readme": true,
+        "screenshot": "examples/svg-barchart.png"
     }
 }
diff --git a/examples/talk-slides/package.json b/examples/talk-slides/package.json
@@ -1,6 +1,6 @@
 {
     "name": "talk-slides",
-    "description": "Presentation slides from ClojureX 2018 keynote",
+    "description": "hdom based slide deck viewer & slides from my ClojureX 2018 keynote",
     "version": "0.0.1",
     "repository": "https://github.com/thi-ng/umbrella",
     "author": "Karsten Schmidt <[email protected]>",
@@ -28,5 +28,13 @@
     ],
     "browser": {
         "process": false
+    },
+    "thi.ng": {
+        "readme": [
+            "hdom",
+            "rstream",
+            "transducers-hdom"
+        ],
+        "screenshot": "examples/talk-slides.png"
     }
 }
diff --git a/examples/todo-list/package.json b/examples/todo-list/package.json
@@ -33,6 +33,7 @@
             "atom",
             "hdom",
             "paths"
-        ]
+        ],
+        "screenshot": "examples/todo-list.png"
     }
 }
diff --git a/examples/triple-query/package.json b/examples/triple-query/package.json
@@ -42,6 +42,7 @@
             "paths",
             "rstream-query",
             "transducers"
-        ]
+        ],
+        "screenshot": "examples/triple-query.png"
     }
 }
diff --git a/examples/webgl-cube/package.json b/examples/webgl-cube/package.json
@@ -38,6 +38,7 @@
             "transducers",
             "vectors",
             "webgl"
-        ]
+        ],
+        "screenshot": "examples/webgl-cube.png"
     }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,6 +33,7 @@ @@
                 "atom",
                 "hdom",
                 "paths"
-            ]
+            ],
+            "screenshot": "examples/todo-list.png"
         }
     }