@uge/payo 2.2.0 → 2.3.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
@@ -101,7 +101,28 @@ chat for the third time, Payo is for you.
101
101
 
102
102
  ## Quick Start
103
103
 
104
- No install required — run it in any project directory:
104
+ **macOS / Linux** (and Windows via Git Bash or WSL):
105
+
106
+ ```bash
107
+ curl -fsSL https://payo.uttamgelot.com/install.sh | sh
108
+ ```
109
+
110
+ **Windows** (PowerShell):
111
+
112
+ ```powershell
113
+ irm https://payo.uttamgelot.com/install.ps1 | iex
114
+ ```
115
+
116
+ Then run `payo` in any project directory.
117
+
118
+ The installer needs **no Node.js**. If you already have `bun` or Node >= 20.12
119
+ it installs the npm package (a much smaller download you can update with tools
120
+ you already know); otherwise it downloads a standalone binary. Set
121
+ `PAYO_INSTALL_METHOD=binary` to always get the binary. Re-running the installer
122
+ upgrades in place and cleans up the older copy.
123
+
124
+ <details>
125
+ <summary>Already have Node? You can skip the installer</summary>
105
126
 
106
127
  ```bash
107
128
  npx @uge/payo
@@ -109,15 +130,16 @@ npx @uge/payo
109
130
  bunx @uge/payo
110
131
  ```
111
132
 
112
- > The command you run after install is still `payo`. Install globally with
113
- > `npm i -g @uge/payo` (or `bun add -g @uge/payo`), then just run `payo`.
133
+ Or install it globally with `npm i -g @uge/payo` / `bun add -g @uge/payo`.
134
+
135
+ </details>
114
136
 
115
137
  Answer a short questionnaire about your stack, and Payo drops tailored AI
116
138
  guidance files straight into your repo.
117
139
 
118
140
  ## How to use — a walkthrough
119
141
 
120
- 1. **Run Payo from your project root.** `npx @uge/payo` — it writes into the
142
+ 1. **Run Payo from your project root.** `payo` — it writes into the
121
143
  current directory, so `cd` into the repo first.
122
144
  2. **Existing repo? It's auto-detected.** If Payo finds a manifest, it reads your
123
145
  stack and pre-fills the questionnaire, so most stack questions become a quick
@@ -355,13 +377,38 @@ Have a stack you want supported or an idea to make the flow better?
355
377
 
356
378
  ## Requirements
357
379
 
358
- **To run Payo:** [Node.js](https://nodejs.org) **>= 20.12**. That's it — `npx @uge/payo`
359
- runs the published, Node-targeted binary, so **you do not need Bun to use Payo.**
360
- If you prefer Bun, `bunx @uge/payo` works too.
380
+ **To run Payo:** nothing. The standalone binary from
381
+ [the installer](#quick-start) is self-contained — no Node, no Bun. `git` is used
382
+ if present (to detect your repo) but is not required.
383
+
384
+ **Via npm instead:** [Node.js](https://nodejs.org) **>= 20.12** for
385
+ `npx @uge/payo`. Bun is optional — `bunx @uge/payo` works, but is never
386
+ required to *use* Payo.
387
+
388
+ **Supported by the binary:** macOS (Apple Silicon and Intel), Linux
389
+ (x64 and arm64, glibc) and Windows x64. On Alpine/musl or Windows on ARM the
390
+ installer tells you to use npm instead.
361
391
 
362
392
  **To develop Payo:** [Bun](https://bun.sh) **>= 1.1.0** (the project builds, tests,
363
393
  and runs from source with Bun — see [Run locally](#run-locally)).
364
394
 
395
+ ## Uninstalling
396
+
397
+ Payo writes nothing outside the project you run it in, so removing the CLI is
398
+ all there is to it:
399
+
400
+ ```bash
401
+ rm ~/.local/bin/payo # standalone binary
402
+ npm rm -g @uge/payo # npm install
403
+ bun remove -g @uge/payo # bun install
404
+ ```
405
+
406
+ The installer prints which of the three it used.
407
+
408
+ > **macOS:** binaries fetched by the installer run fine. If you instead
409
+ > download an archive from the Releases page in a browser, macOS quarantines
410
+ > it — clear that with `xattr -d com.apple.quarantine payo`.
411
+
365
412
  ## Run locally
366
413
 
367
414
  Hacking on Payo or running it from source: