viberoom 0.2.0 → 0.2.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 +23 -18
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -18,17 +18,28 @@ Open a room, summon Claude, Codex, Gemini, Cursor, OpenCode or Copilot into it,
18
18
  <img src="https://raw.githubusercontent.com/todor-rusev/viberoom/main/docs/screenshots/conversation.png" width="900" alt="Three vibemates working through a task together">
19
19
  </p>
20
20
 
21
- viberoom is a small local hub with a web UI. Every coding agent on your machine that speaks the
22
- [Agent Client Protocol](https://agentclientprotocol.com) can join a room as a **vibemate**: it runs
23
- as itself, with its own login and subscription, reads the same conversation as everyone else, and
24
- answers you and the other vibemates. Nothing leaves your machine except what each agent sends to its
25
- own provider.
21
+ <p align="center">
22
+ <b>Claude</b> &nbsp;·&nbsp; <b>Codex</b> &nbsp;·&nbsp; <b>Gemini</b> &nbsp;·&nbsp; <b>Cursor</b> &nbsp;·&nbsp; <b>OpenCode</b> &nbsp;·&nbsp; <b>GitHub Copilot</b><br>
23
+ <sub>every agent you already have, each with its own login, in one room</sub>
24
+ </p>
26
25
 
27
26
  ## Why
28
27
 
29
- A single agent is a conversation. Several agents in one room are a team: one defines what "done"
30
- means, one builds, one reviews, and you steer. viberoom gives that team a place to meet, a shared
31
- folder to work in, and rules for who speaks when.
28
+ A single agent is a conversation. Several agents in one room are a **team**: one defines what
29
+ "done" means, one builds, one reviews, and you steer. viberoom gives that team a place to meet, a
30
+ shared folder to work in, and rules for who speaks when.
31
+
32
+ ## Sixty seconds to a room
33
+
34
+ ```sh
35
+ npm install -g viberoom
36
+ viberoom
37
+ ```
38
+
39
+ 1. **Set your vibe.** A name, a face, a line about you.
40
+ 2. **Open a room.** A name and a folder; the vibemates will work there.
41
+ 3. **Summon vibemates.** Pick an agent, name it, give it a character. Repeat.
42
+ 4. **Say hello.** Everyone answers in turn. `@Name` one of them, `/name` runs a skill.
32
43
 
33
44
  ## Highlights
34
45
 
@@ -83,12 +94,7 @@ folder to work in, and rules for who speaks when.
83
94
 
84
95
  ## Install
85
96
 
86
- ```sh
87
- npm install -g viberoom
88
- viberoom
89
- ```
90
-
91
- The menu that appears can install a desktop icon, open the app window, or open a browser tab
97
+ `npm install -g viberoom`, then `viberoom`. The menu that appears can install a desktop icon, open the app window, or open a browser tab
92
98
  (Start Menu on Windows, `~/Applications/viberoom.app` on macOS, an applications-menu entry on Linux).
93
99
  Upgrade with `npm install -g viberoom@latest`; the next start replaces the running hub.
94
100
 
@@ -114,12 +120,11 @@ viberoom open open the window of the running hub
114
120
  viberoom logs the background hub's log
115
121
  ```
116
122
 
117
- The first start asks for your name and a line about you. Then: open a room (name and folder),
118
- summon a vibemate (pick the agent, name it, give it a face), say hello. `Enter` sends,
119
- `Shift+Enter` is a new line, `@Name` addresses one vibemate, `/name` invokes a skill.
123
+ `Enter` sends, `Shift+Enter` is a new line, `@Name` addresses one vibemate, `/name` invokes a skill.
120
124
 
121
125
  Data lives in `~/.viberoom` (or `$VIBEROOM_DATA_DIR`): settings, rooms with their history, skills,
122
- transcripts and the hub log.
126
+ transcripts and the hub log. Nothing leaves your machine except what each agent sends to its own
127
+ provider.
123
128
 
124
129
  ## Settings worth knowing
125
130
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "viberoom",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "viberoom: group chat rooms for a human and several coding agents over the Agent Client Protocol",
5
5
  "type": "module",
6
6
  "engines": {