opencode-traffic-light 1.0.0 → 1.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 +4 -38
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,51 +12,17 @@ A TUI plugin that adds a status indicator to your terminal title bar, giving you
12
12
 
13
13
  ## Installation
14
14
 
15
- ### Option 1: Install from npm (recommended)
15
+ Add the plugin to your **`tui.json`**:
16
16
 
17
- Install the package:
18
-
19
- ```bash
20
- npm install opencode-traffic-light
21
- ```
22
-
23
- Then add to your project's `.opencode/tui.json`:
24
-
25
- ```jsonc
17
+ ```json
26
18
  {
27
19
  "plugin": ["opencode-traffic-light"]
28
20
  }
29
21
  ```
30
22
 
31
- Or install globally via `~/.config/opencode/tui.json`.
32
-
33
- ### Option 2: Install from GitHub
34
-
35
- Add to your project's `.opencode/tui.json`:
36
-
37
- ```jsonc
38
- {
39
- "plugin": ["opencode-traffic-light@git+https://github.com/niushuai1991/opencode-traffic-light.git"]
40
- }
41
- ```
42
-
43
- Or install globally via `~/.config/opencode/tui.json`.
44
-
45
- ### Option 3: Local plugin file
46
-
47
- Copy `src/index.ts` into your project's plugin directory:
48
-
49
- ```
50
- .opencode/plugins/traffic-light.ts
51
- ```
52
-
53
- ### Option 4: Global plugin file
54
-
55
- Copy `src/index.ts` to the global plugin directory:
23
+ That's it. OpenCode will automatically install the plugin on next run.
56
24
 
57
- ```
58
- ~/.config/opencode/plugins/traffic-light.ts
59
- ```
25
+ > **Note:** This is a TUI plugin, so it must be configured in `~/.config/opencode/tui.json`, not `opencode.json`.
60
26
 
61
27
  ## Usage
62
28
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opencode-traffic-light",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "TUI plugin that adds a traffic-light status indicator to your OpenCode terminal title",
5
5
  "type": "module",
6
6
  "license": "MIT",