docs(examples): update readme & screenshot

thi-ng · Oct 31, 2022 · b27fd07 · b27fd07
1 parent 7c5c0cb
commit b27fd07
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/assets/examples/zig-counter.png b/assets/examples/zig-counter.png
diff --git a/examples/zig-counter/package.json b/examples/zig-counter/package.json
@@ -28,7 +28,8 @@
 	"thi.ng": {
 		"readme": [
 			"wasm-api",
-			"wasm-api-dom"
+			"wasm-api-dom",
+			"wasm-api-timer"
 		],
 		"screenshot": "examples/zig-counter.png"
 	}

diff --git a/packages/wasm-api-timer/README.md b/packages/wasm-api-timer/README.md
@@ -13,6 +13,7 @@ This project is part of the
 - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
 - [Authors](#authors)
 - [License](#license)
@@ -92,6 +93,18 @@ Package sizes (gzipped, pre-treeshake): ESM: 446 bytes
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
 - [@thi.ng/wasm-api](https://github.com/thi-ng/umbrella/tree/develop/packages/wasm-api)
 
+## Usage examples
+
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory are using this package.
+
+A selection:
+
+| Screenshot                                                                                                         | Description                                 | Live demo                                         | Source                                                                         |
+|:-------------------------------------------------------------------------------------------------------------------|:--------------------------------------------|:--------------------------------------------------|:-------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/zig-counter.png" width="240"/> | Simple Zig/WASM click counter DOM component | [Demo](https://demo.thi.ng/umbrella/zig-counter/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/zig-counter) |
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/wasm-api-timer/)