@profullstack/readm3 0.17.0 → 0.18.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
@@ -416,17 +416,28 @@ expires). Only the changed lines are sent, never the whole file. Each summary is
416
416
  at a multiple of what the model call cost; the multiple is a two-arm price experiment
417
417
  (2x or 4x), assigned once per account. A refused or failed call is not charged.
418
418
 
419
+ **Summarize** (toolbar, or `File: Summarize with AI` in the palette) does the same for
420
+ the whole open document: a short abstract and its key points. Signed in, the first
421
+ **10 documents a week are free** (Monday 00:00 UTC to the next); after that each one is
422
+ charged from the balance like a change summary. Free summaries carry no price arm, so
423
+ the experiment counts only paid ones. Up to 400 KB of text; the first 60,000
424
+ characters are sent. Pressing Summarize again on unchanged text shows the same summary
425
+ without a second call.
426
+
419
427
  | Endpoint | |
420
428
  | --- | --- |
421
429
  | `GET /api/v1/billing` | balance, price arm and multiplier, recent ledger |
422
430
  | `POST /api/v1/billing/topups` `{ amountUsd, chain? }` | starts a CoinPay payment, returns `payUrl` |
423
431
  | `GET /api/v1/billing/topups/<id>` | `pending` or `paid` |
424
432
  | `POST /api/v1/summaries` `{ path, before, after }` | the abstract, `chargedMicros`, new balance |
433
+ | `POST /api/v1/summaries/document` `{ path, text }` | a summary of a whole document; `free`, `chargedMicros`, `freeSummaries { perWeek, left, resetsAt }`, new balance |
425
434
  | `GET /api/v1/billing/experiment` | admins: per arm accounts, payers, top-ups, summaries, revenue, model cost |
426
435
  | `POST /api/v1/billing/coinpay/webhook` | CoinPay's signed webhook (`t=…,v1=` HMAC-SHA256) |
427
436
 
428
437
  Server configuration: `ANTHROPIC_API_KEY` turns summaries on (`READM3_SUMMARY_MODEL`,
429
- default `claude-opus-5-5`, run at low effort); `COINPAY_API_KEY`, `COINPAY_BUSINESS_ID`
438
+ default `claude-opus-5-5`, run at low effort) and `OPENAI_API_KEY` is the fallback when
439
+ the Claude call fails (`READM3_OPENAI_MODEL`, default `gpt-5.2`); either one alone works.
440
+ `READM3_FREE_SUMMARIES_PER_WEEK` changes the free allowance (default 10). `COINPAY_API_KEY`, `COINPAY_BUSINESS_ID`
430
441
  and `COINPAY_WEBHOOK_SECRET` open top-ups (`COINPAY_API_URL` defaults to
431
442
  coinpayportal.com). Without them the history still works and the paid parts say so.
432
443
 
package/dist/cli.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { type ColorMode } from "./print.ts";
2
2
  import { type ViewerOptions } from "./viewer.ts";
3
- export declare const VERSION = "0.17.0";
3
+ export declare const VERSION = "0.18.0";
4
4
  /** The help text, exported so a test can hold it to the flags it documents. */
5
5
  export declare const USAGE: string;
6
6
  export interface ParsedArgs extends ViewerOptions {
package/dist/cli.js CHANGED
@@ -11,7 +11,7 @@ import { printDocument, COLOR_MODES } from "./print.js";
11
11
  import { run } from "./viewer.js";
12
12
  import { isCloudCommand, cloudMain, CLOUD_USAGE } from "./cloud-cli.js";
13
13
  import { isDesktopCommand, desktopMain, installedDesktop, prefersDesktop, DESKTOP_USAGE } from "./desktop-cli.js";
14
- export const VERSION = "0.17.0";
14
+ export const VERSION = "0.18.0";
15
15
  /** The help text, exported so a test can hold it to the flags it documents. */
16
16
  export const USAGE = `readm3 — a plain text editor for Markdown and code
17
17
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@profullstack/readm3",
3
- "version": "0.17.0",
3
+ "version": "0.18.0",
4
4
  "description": "Markdown editing and sharing for people and teams. Web/PWA, CLI, API and MCP with version history, view/edit links, and a terminal reader.",
5
5
  "type": "module",
6
6
  "license": "MIT",