smart-home-engine 1.10.2 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -15,16 +15,32 @@ Your home, your rules - written in plain JavaScript.
15
15
  - **Broker management** — optional Mosquitto management: dynamic user/ACL management via the dynsec plugin (`she.broker.*` script API), listener and TLS configuration, TLS certificate management (server cert self-signed / CSR / import, trusted CA store), SSH-based remote file deployment
16
16
  - **Web UI** — script editor, package manager, MQTT browser, Matter device manager, sheDB frontend, log viewer, broker manager
17
17
 
18
- ## Docs
19
-
20
- | | |
21
- |---|---|
22
- | [Getting started](doc/getting-started.md) | Install, write your first script, configure |
23
- | [Sandbox API](doc/sandbox-api.md) | Everything available inside a script |
24
- | [sheDB](doc/db/README.md) | Embedded document store — script API, views, examples |
25
- | [Broker management](doc/broker-management.md) | Mosquitto management, dynsec, TLS, certificates |
26
- | [Examples](doc/examples.md) | Real-world script patterns |
27
- | [HTTP API](doc/http-api.md) | REST API reference including broker management endpoints |
18
+ ## Documentation
19
+
20
+ ### Getting started
21
+ - [Getting started](doc/getting-started.md) — install, first script, systemd service, Docker
22
+ - [Concepts](doc/concept.md) zero-boilerplate scripting, MQTT vs. sheDB, broker access control, git integration
23
+
24
+ ### Scripting
25
+ - [Script Engine](doc/script-engine.md) execution model, hot-reload, module system, ESM limitations
26
+ - [Sandbox API](doc/sandbox-api.md) everything available inside a script (`she.mqtt`, `she.schedule`, `she.db`, …)
27
+ - [Examples](doc/examples.md) real-world script patterns
28
+
29
+ ### sheDB
30
+ - [sheDB overview](doc/db/README.md) — when and why to use the embedded document store
31
+ - [Documents](doc/db/documents.md) — CRUD, deep merge, nested property mutations
32
+ - [Views](doc/db/views.md) — map/reduce queries
33
+ - [View examples](doc/db/view-examples.md)
34
+ - [Sandbox API](doc/db/sandbox.md) — `she.db.*` reference
35
+
36
+ ### Operations & integration
37
+ - [Security](doc/security.md) — trust model, auth modes, reverse proxy, Mosquitto ACLs, network segmentation
38
+ - [Broker management](doc/broker-management.md) — Mosquitto, dynsec, TLS, certificates, SSH deploy
39
+ - [HTTP API](doc/http-api.md) — REST API reference
40
+ - [CLI](doc/cli.md) — all command-line flags
41
+
42
+ ### Development
43
+ - [Backlog](BACKLOG.md) — planned features, deferred ideas, open design questions
28
44
 
29
45
  ## Quick look
30
46