@routecraft/routecraft 0.5.0-canary.9 → 0.5.0

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.
package/README.md CHANGED
@@ -7,13 +7,13 @@ Routecraft is a TypeScript-first framework for building automation capabilities
7
7
  ## Installation
8
8
 
9
9
  ```bash
10
- npm install @routecraft/routecraft
11
- ```
12
-
13
- or
10
+ # Bun (recommended)
11
+ bun add @routecraft/routecraft
14
12
 
15
- ```bash
13
+ # npm / pnpm / yarn
14
+ npm install @routecraft/routecraft
16
15
  pnpm add @routecraft/routecraft
16
+ yarn add @routecraft/routecraft
17
17
  ```
18
18
 
19
19
  ## Quick Start
@@ -29,12 +29,14 @@ export default craft()
29
29
  .to(log());
30
30
  ```
31
31
 
32
- Run it directly:
32
+ Run it directly with the `craft` CLI (requires Bun on the host):
33
33
 
34
34
  ```bash
35
- npx @routecraft/cli run capabilities/timer-ping.ts
35
+ bunx @routecraft/cli run capabilities/timer-ping.ts
36
36
  ```
37
37
 
38
+ For Node-based projects, embed the library programmatically instead of using the CLI -- see [Programmatic Invocation](https://routecraft.dev/docs/advanced/programmatic-invocation).
39
+
38
40
  ## Core Concepts
39
41
 
40
42
  ### Capabilities