pi-mega-compact 0.4.11 → 0.4.12

package/README.md

@@ -111,50 +111,45 @@ OpenAI-style contract and the `MEGACOMPACT_EMBEDDING_KEY` / `MEGACOMPACT_EMBEDDI
 ### Requirements
 
 - **Node >= 18**
-- `npm install` builds the **`better-sqlite3`** native module (one-time, local
+- install builds the **`better-sqlite3`** native module (one-time, local
   compile). No network call and no API key are needed at runtime.
-- A pi coding agent install that loads extensions from `~/.pi/agent/extensions/`.
+- A pi coding agent install with package support (`pi install` / `pi update
+  --extensions`). npm-installed packages are auto-discovered via the package's
+  `pi` manifest entry; local checkouts load from `~/.pi/agent/extensions/`.
 
 ### Install from npm (recommended)
 
-```bash
-npm install pi-mega-compact
-```
-
-This places the package in `node_modules` and exposes the extension entry at
-`node_modules/pi-mega-compact/extensions/mega-compact.ts`. Then point pi at it
-(see "Register with pi" below).
-
-### Register with pi
-
-Add the extension to your pi config's `pi.extensions` list, pointing at the
-installed entry (npm path or a symlink into pi's extensions dir — either works):
-
-```jsonc
-{
-  "pi": {
-    "extensions": ["pi-mega-compact/extensions/mega-compact.ts"]
-  }
-}
-```
-
-Or symlink the installed package into pi's extensions dir (the simplest path if
-you run pi from the same machine):
+pi installs extensions as **packages**. `pi install npm:<pkg>` writes an
+`npm:` source into your pi config's `packages` array; pi then auto-discovers the
+extension from the package's own `"pi": { "extensions": [...] }` manifest entry
+— **no manual `settings.json` edit is needed**.
 
 ```bash
-ln -s "$(npm root)/pi-mega-compact" ~/.pi/agent/extensions/pi-mega-compact
+pi install npm:pi-mega-compact        # first time: adds to packages + installs
+pi update --extensions                # thereafter: pulls the latest published version
 ```
 
-> **From a git checkout (development).** To hack on the extension, clone instead
-> and build locally:
+`pi update --extensions` refreshes every `npm:` entry in `packages` (including on
+other devices that share this config). The package ships both the TypeScript
+source (which pi loads directly) and the compiled `dist/`, so nothing else needs
+building.
+
+> **Tip — keep the spec unpinned.** Use `npm:pi-mega-compact`, not
+> `npm:pi-mega-compact@0.4.11`. Version-pinned specs are *skipped* by
+> `pi update --extensions`, so a pin would freeze you on that release.
+
+> **From a git checkout (development only).** To hack on the extension, clone and
+> build locally, then symlink it into pi's extensions dir — but this bypasses the
+> package manager, so it is NOT updated by `pi update --extensions`. Convert to the
+> npm package (above) before shipping. The bundled `./install.sh` helper does the
+> symlink + config edit (needs `jq`).
+>
 > ```bash
 > git clone https://github.com/TheArchitectit/pi-mega-compact.git \
 >   ~/.pi/agent/extensions/pi-mega-compact
 > cd ~/.pi/agent/extensions/pi-mega-compact
 > npm install && npm run build
 > ```
-> The bundled `./install.sh` helper (`copy`) / `./install.sh -s` (`symlink`) does
-> the same and also registers the path in pi's config (needs `jq`).
 
 ### Verify
 
@@ -166,17 +161,17 @@ npm run lint      # tsc --noEmit + guardrails scan clean
 ### Uninstall
 
 ```bash
+pi uninstall npm:pi-mega-compact   # removes from settings.packages + the npm tree
+# or, to keep the config entry but drop the package:
 npm uninstall pi-mega-compact
 ```
 
-If you symlinked it into pi's extensions dir, also remove that link:
+If you symlinked it into pi's extensions dir (dev only), also remove that link:
 
 ```bash
 rm -f ~/.pi/agent/extensions/pi-mega-compact
 ```
 
-Then remove the path from pi's `pi.extensions` array.
-
 ---
 
 ## How to use it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-mega-compact",
-  "version": "0.4.11",
+  "version": "0.4.12",
   "description": "Layered, local, vector-backed context compressor for pi — supersede/collapse/cluster compaction with deduped inline recall.",
   "type": "module",
   "license": "BSD-2-Clause",