@rmrdeveloper/sideroom-pi 5.0.0 → 5.0.1

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 +16 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Sideroom Pi
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@rmrdeveloper/sideroom-pi?label=npm&logo=npm)](https://www.npmjs.com/package/@rmrdeveloper/sideroom-pi)
4
+ [![npm monthly downloads](https://img.shields.io/npm/dm/@rmrdeveloper/sideroom-pi?label=downloads&logo=npm)](https://www.npmjs.com/package/@rmrdeveloper/sideroom-pi)
5
+ [![npm license](https://img.shields.io/npm/l/@rmrdeveloper/sideroom-pi?label=license)](https://www.npmjs.com/package/@rmrdeveloper/sideroom-pi)
6
+
3
7
  Sideroom Pi is a global [Pi package](https://pi.dev/docs/latest/packages). It
4
8
  registers the `/sideroom` command inside Pi and runs planner, implementer,
5
9
  reviewer, verifier, and fixer as isolated Pi SDK sessions.
@@ -7,23 +11,28 @@ reviewer, verifier, and fixer as isolated Pi SDK sessions.
7
11
  It creates no `.pi` configuration, task graph, harness state, or other files
8
12
  in the repository being changed.
9
13
 
10
- ## Install globally in Pi
14
+ ## Install
11
15
 
12
- Build the package, then let Pi install it globally. Do not use `-l`: that
13
- would create project-local configuration.
16
+ Install Sideroom globally from npm. Pi writes this installation to your user
17
+ settings, so do not use `-l`.
14
18
 
15
19
  ```bash
16
- npm install
17
- npm run build
18
- pi install /absolute/path/to/sideroom-pi
20
+ pi install npm:@rmrdeveloper/sideroom-pi
19
21
  ```
20
22
 
21
- For a published release:
23
+ For a reproducible environment, install a specific release instead. A pinned
24
+ version does not move when you run Pi's package update command.
22
25
 
23
26
  ```bash
24
27
  pi install npm:@rmrdeveloper/sideroom-pi@5.0.0
25
28
  ```
26
29
 
30
+ To update an unpinned installation:
31
+
32
+ ```bash
33
+ pi update --extension npm:@rmrdeveloper/sideroom-pi
34
+ ```
35
+
27
36
  Start Pi from the repository you want to work in, then invoke the extension:
28
37
 
29
38
  ```text
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rmrdeveloper/sideroom-pi",
3
- "version": "5.0.0",
3
+ "version": "5.0.1",
4
4
  "description": "A global Pi package that runs an isolated coding-agent pipeline through /sideroom.",
5
5
  "type": "module",
6
6
  "files": [