happier-tui 0.1.0 → 0.1.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 +13 -6
  2. package/package.json +10 -2
package/README.md CHANGED
@@ -6,7 +6,7 @@ Pick a session running on any of your machines, read it live, send prompts, answ
6
6
  requests, start new sessions — and get a bell or a notification from your terminal, tmux or cmux
7
7
  when an agent needs you.
8
8
 
9
- ![happier-tui start screen](assets/main.png)
9
+ ![happier-tui start screen](https://raw.githubusercontent.com/CyrilPeponnet/happier-tui/main/assets/main.png)
10
10
 
11
11
  happier-tui is an independent, unofficial client. It talks to the Happier relay directly (HTTP and
12
12
  Socket.IO, end-to-end encrypted) and is built on
@@ -25,16 +25,23 @@ You need two things on the machine first:
25
25
  Then:
26
26
 
27
27
  ```bash
28
- git clone <repo-url> happier-tui
28
+ npm install -g happier-tui
29
+ ```
30
+
31
+ Run `happier-tui`. To update: run the same command again. To remove it:
32
+ `npm uninstall -g happier-tui`.
33
+
34
+ ### From source
35
+
36
+ ```bash
37
+ git clone https://github.com/CyrilPeponnet/happier-tui.git
29
38
  cd happier-tui
30
39
  npm install # downloads dependencies and builds
31
40
  npm install -g . # adds the `happier-tui` command
32
41
  ```
33
42
 
34
- Run `happier-tui`. To update later: `git pull && npm install` in the same folder. To remove it:
35
- `npm uninstall -g happier-tui`.
36
-
37
- Prefer not to install a command? Skip the last step and run `node dist/main.js` from the folder.
43
+ To update: `git pull && npm install` in the same folder. Without installing a command, run
44
+ `node dist/main.js` from the folder.
38
45
 
39
46
  ## Use
40
47
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "happier-tui",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Terminal client for Happier agent sessions, with bell and notification support for tmux, cmux and other terminals",
5
5
  "scripts": {
6
6
  "test": "node --import tsx --test test/*.test.ts",
@@ -41,5 +41,13 @@
41
41
  "dist",
42
42
  "README.md",
43
43
  "LICENSE"
44
- ]
44
+ ],
45
+ "repository": {
46
+ "type": "git",
47
+ "url": "git+https://github.com/CyrilPeponnet/happier-tui.git"
48
+ },
49
+ "homepage": "https://github.com/CyrilPeponnet/happier-tui#readme",
50
+ "bugs": {
51
+ "url": "https://github.com/CyrilPeponnet/happier-tui/issues"
52
+ }
45
53
  }