@munusshih/p5.export 0.1.0-beta.10 → 0.1.0-beta.11

package/README.md

@@ -1,5 +1,9 @@
 # p5.export
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/munusshih/p5.export/main/p5.export.png" alt="p5.export panel previewing an animated p5.js sketch" width="900">
+</p>
+
 [![npm version](https://img.shields.io/npm/v/%40munusshih%2Fp5.export?logo=npm&color=cb3837)](https://www.npmjs.com/package/@munusshih/p5.export)
 [![npm downloads](https://img.shields.io/npm/dm/%40munusshih%2Fp5.export?logo=npm)](https://www.npmjs.com/package/@munusshih/p5.export)
 [![license](https://img.shields.io/npm/l/%40munusshih%2Fp5.export)](./LICENSE)
@@ -121,7 +125,13 @@ function setup() {
 ### Video (record once, export to multiple formats)
 
 ```js
-const buffer = createVideoBuffer({ duration: 3, fps: 30 });   // starts immediately
+// Starts immediately. By default, export timing follows the rate set by
+// frameRate(), so a frameRate(1) sketch remains one frame per second.
+const buffer = createVideoBuffer({ duration: 3 });
+
+// Record a sharper 2× render. Set fps only when you intentionally want to
+// override the sketch's target frame rate.
+const hiResBuffer = createVideoBuffer({ duration: 3, scale: 2, fps: 30 });
 
 // later, after the buffer auto-stops or you call `stopVideoBuffer()`:
 await exportVideoBuffer(buffer, { format: 'mp4',  filename: 'clip' });
@@ -130,7 +140,7 @@ await exportVideoBuffer(buffer, { format: 'webp', filename: 'clip' });  // anima
 await exportVideoBuffer(buffer, { format: 'gif',  filename: 'clip' });
 ```
 
-Frames are captured in real RGBA at the canvas's native resolution. `exportVideoBuffer()` is re-callable on the same buffer — no re-recording — so users can pick the format they want from the GUI without losing the take.
+Frames are captured in real RGBA at the sketch's target frame rate. Set `scale` from 1–4 to render the recording at that pixel density instead of enlarging the encoded pixels afterward. `exportVideoBuffer()` is re-callable on the same buffer — no re-recording — so users can pick the format they want from the GUI without losing the take.
 
 You can also do a one-shot `recordVideo({ format: 'mp4', duration: 3, filename: 'clip' })` if you don't need the multi-format buffer.
 
@@ -157,7 +167,7 @@ createExportGUI({ title: 'my sketch', filename: 'artwork', collapsed: false });
 removeExportGUI();
 ```
 
-Drag from the header to move it. The two tabs (Image / Video) share the same compact form. The Video tab shows a low-res preview with a scrubbable timeline before you commit to encoding.
+Drag from the header to move it. The two tabs (Image / Video) share the same compact form. The Video tab includes a 1×–4× recording scale and shows a low-res preview with a scrubbable timeline before you commit to encoding.
 
 ## Browser support