this.me 3.1.5 → 3.1.7

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.
Files changed (2) hide show
  1. package/README.md +54 -2
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -8,6 +8,11 @@
8
8
  ```bash
9
9
  npm install this.me
10
10
  ```
11
+
12
+ <p align="right">
13
+ <a href="https://neurons-me.github.io/.me/docs/">✍ Read the Docs →</a>
14
+ </p>
15
+
11
16
  ## **Start .me in 60 seconds**
12
17
  ###### Import
13
18
  ```ts
@@ -64,6 +69,25 @@ me.home.kitchen.lights["="]("avg", "(main.brightness + leds.brightness) / 2"); /
64
69
  me("home.kitchen.lights.avg"); // → 60
65
70
  ```
66
71
 
72
+ ```txt
73
+ Runtime output (real):
74
+ avg -> 60
75
+
76
+ inspect().index ->
77
+ {
78
+ "home.kitchen.lights.main.brightness": 80,
79
+ "home.kitchen.lights.leds.brightness": 40,
80
+ "home.kitchen.lights.avg": 60
81
+ }
82
+
83
+ last thoughts ->
84
+ [
85
+ { path: "home.kitchen.lights.main.brightness", op: null, value: 80 },
86
+ { path: "home.kitchen.lights.leds.brightness", op: null, value: 40 },
87
+ { path: "home.kitchen.lights.avg", op: "=", value: 60 }
88
+ ]
89
+ ```
90
+
67
91
  You can **bridge** distant rooms with **Pointers**:
68
92
  ```ts
69
93
  // Create a "Master Switch" at your root
@@ -107,6 +131,19 @@ me.wallet.balance(500);
107
131
  me.wallet.note("Private savings");
108
132
  ```
109
133
 
134
+ ```txt
135
+ After these writes:
136
+
137
+ Public index plane (inspect().index):
138
+ "" -> { __id: "jabellae" }
139
+
140
+ Secret scope roots:
141
+ ["wallet"]
142
+
143
+ Encrypted branch plane (exportSnapshot().encryptedBranches):
144
+ wallet -> 0x4b46...6f1c4e
145
+ ```
146
+
110
147
  Everything under a `["_"]` scope is **stored as an Encrypted Blob**. By design, secret roots are Stealth:
111
148
  ```ts
112
149
  me("wallet"); // → undefined (The root is a ghost)
@@ -136,6 +173,22 @@ me("wallet.hidden.note");// → "Deep dark secret"
136
173
  - If you declare another secret inside, it becomes a deeper encrypted scope.
137
174
  - Reads are path-based; there is no global `me.secret(...)` unlock call.
138
175
 
176
+ ###### Structural view (public vs secret planes)
177
+ ```txt
178
+ Public index plane (inspect().index):
179
+ "" -> { __id: "jabellae" }
180
+
181
+ Secret scope roots:
182
+ ["wallet"]
183
+
184
+ Encrypted branch plane (exportSnapshot().encryptedBranches):
185
+ wallet -> 0x4b46...6f1c4e
186
+
187
+ Read behavior:
188
+ me("wallet") -> undefined
189
+ me("wallet.balance") -> 500
190
+ ```
191
+
139
192
  ---
140
193
 
141
194
  ## ⟐ Why .me?
@@ -232,9 +285,8 @@ The behavior is identical, bit-by-bit, because the logic is part of the state.
232
285
  ##### License
233
286
  **MIT © 2025 by https://neurons.me**
234
287
 
235
- See the [LICENSE](./LICENSE) file for details.
288
+ See the `LICENSE` file in the package root for details.
236
289
 
237
290
  **∴ Witness our seal**
238
291
 
239
292
  **suiGn**
240
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "this.me",
3
- "version": "3.1.5",
3
+ "version": "3.1.7",
4
4
  "type": "module",
5
5
  "main": "./dist/me.cjs",
6
6
  "module": "./dist/me.es.js",
@@ -26,7 +26,8 @@
26
26
  "docs:api:watch": "typedoc --watch",
27
27
  "docs:dev": "vitepress dev docs",
28
28
  "docs:build": "vitepress build docs",
29
- "docs:preview": "vitepress preview docs"
29
+ "docs:preview": "vitepress preview docs",
30
+ "docs:publish": "npm run docs:build && rm -rf ../docs && mkdir -p ../docs && cp -R docs/.vitepress/dist/* ../docs/ && touch ../docs/.nojekyll"
30
31
  },
31
32
  "files": [
32
33
  "dist"