pi-better-background-tasks 0.1.3 → 0.1.5

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +19 -2
  3. package/package.json +8 -5
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 1aboveio
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,8 +1,10 @@
1
1
  # pi-better-background-tasks
2
2
 
3
- Durable background processes and watchers for [Pi](https://pi.dev).
3
+ `pi-better-background-tasks` is a Pi extension for durable background shell tasks, watchers, logs, and status inspection.
4
4
 
5
- Use it when work should keep running while the foreground session stays free: dev servers, long scripts, queue watchers, deploy checks, log tails, and other command-driven tasks.
5
+ ## Quick Answer
6
+
7
+ Use `pi-better-background-tasks` when a command should keep running while the foreground Pi session stays free. It is best for dev servers, long scripts, queue watchers, deploy checks, log tails, and other command-driven work.
6
8
 
7
9
  ## Core Features
8
10
 
@@ -23,6 +25,20 @@ Try it for one run:
23
25
  pi -e npm:pi-better-background-tasks
24
26
  ```
25
27
 
28
+ ## When To Use
29
+
30
+ Use this package for shell commands that need logs, status, cancellation, or completion notifications across a Pi turn.
31
+
32
+ Do not use it for short commands where the foreground session should wait for the result directly.
33
+
34
+ ## Compatibility
35
+
36
+ | Requirement | Support |
37
+ |-------------|---------|
38
+ | Pi | Required |
39
+ | Install method | `pi install npm:pi-better-background-tasks` |
40
+ | Development runtime | Node.js 22+ |
41
+
26
42
  ## Update Or Remove
27
43
 
28
44
  ```sh
@@ -34,3 +50,4 @@ pi remove npm:pi-better-background-tasks
34
50
 
35
51
  - Repository: https://github.com/1aboveio/pi-better-harness
36
52
  - Detailed notes: https://github.com/1aboveio/pi-better-harness/blob/main/packages/pi-better-background-tasks/docs/usage.md
53
+ - License: https://github.com/1aboveio/pi-better-harness/blob/main/LICENSE
package/package.json CHANGED
@@ -1,12 +1,15 @@
1
1
  {
2
2
  "name": "pi-better-background-tasks",
3
- "version": "0.1.3",
4
- "description": "Generic durable background task and watcher tools for pi.",
3
+ "version": "0.1.5",
4
+ "description": "Pi extension for durable background shell tasks, watchers, logs, and status inspection.",
5
+ "license": "MIT",
5
6
  "type": "module",
6
7
  "keywords": [
7
8
  "pi-package",
8
9
  "pi-extension",
9
- "background-tasks"
10
+ "pi",
11
+ "background-tasks",
12
+ "watchers"
10
13
  ],
11
14
  "pi": {
12
15
  "extensions": [
@@ -46,8 +49,8 @@
46
49
  },
47
50
  "devDependencies": {
48
51
  "@types/node": "^22.10.0",
52
+ "typebox": "^1.1.38",
49
53
  "typescript": "^5.7.0",
50
- "vitest": "^3.0.0",
51
- "typebox": "^1.1.38"
54
+ "vitest": "^3.0.0"
52
55
  }
53
56
  }