ripgrep 0.0.1 → 0.1.0

package/README.md

@@ -6,11 +6,8 @@
 
 ```sh
 npx ripgrep TODO src/
-```
-
-Or install globally:
 
-```sh
+# or install globally
 npm i -g ripgrep
 rg TODO src/
 ```
@@ -18,10 +15,15 @@ rg TODO src/
 ## Programmatic API
 
 ```js
-import { ripgrep } from "ripgrep";
+import { ripgrep, rgPath } from "ripgrep";
 
+// Run ripgrep programmatically
 const { code } = await ripgrep(["--json", "TODO", "src"]);
 // 0 = matches found, 1 = no matches, 2 = error
+
+// Or spawn as a child process (drop-in for vscode-ripgrep)
+import { spawn } from "node:child_process";
+spawn(rgPath, ["TODO", "src"], { stdio: "inherit" });
 ```
 
 ### `ripgrep(args, options)`
@@ -33,18 +35,11 @@ Options:
 - `env` — environment variables passed to the WASI instance (default: `process.env`).
 - `preopens` — WASI preopened directories mapping guest paths to host paths (default: `{ ".": process.cwd() }`). Required for ripgrep to see any files on disk.
 - `returnOnExit` — when `true`, `proc_exit` returns the exit code instead of terminating the process (default: `true`).
-- `nodeWasi` — use Node's built-in `node:wasi` instead of the bundled WASI shim (default: `false`, also enabled via `ZIGREP_NODE_WASI=1`).
+- `nodeWasi` — use Node's built-in `node:wasi` instead of the bundled WASI shim. Enabled by default on Node.js for best performance; automatically disabled on Bun and Deno where `node:wasi` is not available, falling back to the bundled shim. Can also be forced on via `ZIGREP_NODE_WASI=1`.
 
 ### `rgPath`
 
-Absolute filesystem path to a JS shim that runs ripgrep via `ripgrep`. Drop-in replacement for `rgPath` from `vscode-ripgrep` / `@vscode/ripgrep`-style consumers that spawn the binary directly:
-
-```js
-import { spawn } from "node:child_process";
-import { rgPath } from "ripgrep";
-
-spawn(rgPath, ["TODO", "src"], { stdio: "inherit" });
-```
+Absolute filesystem path to a JS shim that runs ripgrep via `ripgrep`. Drop-in replacement for `rgPath` from `vscode-ripgrep` / `@vscode/ripgrep`-style consumers that spawn the binary directly.
 
 ## How it works