@medeo-plugin/plugin-screenshot 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# Screenshot
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Capture any part of the screen and annotate it in place: select, add arrows, blur, number the
+steps, then copy or save in one go.
+
+![Screenshot editor](media/en/editor.png)
+
+- **Capture**: ⌘⇧X (area), plus optional shortcuts for full screen, quick capture and OCR; the
+  menu-bar icon and the launcher (`shot`). The display under the pointer is frozen with macOS's
+  `screencapture`; drag to select (Shift for a square), click a window (Tab toggles snapping), F
+  for the whole display.
+- **Tools** (single-key shortcuts): Select S, Arrow A (5 styles), Line L, Pencil P, Marker M,
+  Rectangle R / Ellipse O (outline, fill, corner radius), Text T (bold, italic, underline,
+  alignment, background), Number N (1/I/A/a), Censor B (pixelate, blur, solid), Highlight H,
+  Stamp G, Measure U, Color sampler I. Click any annotation to edit, move, resize or delete it;
+  hold Space while drawing to move, Shift to constrain.
+- **Actions**: copy ⌘C, save ⌘S (PNG or JPEG, optional 1×), read text and QR codes with Apple
+  Vision, beautify (gradient, padding, window frame), invert.
+
+![Screenshot settings](media/en/settings.png)
+
+Runtime: Node (macOS). Permissions: `node`, `app_windows`, `window_management` (the full-screen
+overlay), `screen_capture` (reports and requests macOS Screen Recording), `global_shortcuts`,
+`tray`, `notifications`. AppKit access goes through `resources/helper.js`, run with
+`osascript -l JavaScript`; no native binaries are shipped.
+
+Not yet: pin to screen (needs a floating window type in the host), scroll capture, recording,
+multi-display selections.
+
+---
+
+Install from npm in Medeo's plugin center, or use Discover.
+
+Plugin ID: app.medeo.screenshot
+Version: 1.0.1
+Publisher: 6ac813f5c19a51d6fea83a03fa1306e1d0e88c80f5af3a2000ff80a0e2f116f9
+SHA-256: 722efb08c521f2d2bbb19a631dbb104f74ddca68c9093c73197d6d400703dc58
+
+Approve permissions in Medeo before use.