π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
docs(readme): describe sharing a guide as a .mimik file
davbio4f0a2a492101
diff --git a/README.md b/README.mdindex 87c43e5..f3610ce 100644--- a/README.md+++ b/README.md@@ -38,6 +38,7 @@ Click record, do the thing, get a polished guide with annotated screenshots. Nar- [ποΈ Voice narration (optional)](#οΈ-voice-narration-optional)- [βοΈ Guide editor](#οΈ-guide-editor)- [π€ Multi-format export](#-multi-format-export)+ - [π¦ Share a guide](#-share-a-guide)- [π Privacy & storage](#-privacy--storage)- [π€ Contributing](#-contributing)- [β Star History](#-star-history)@@ -160,10 +161,12 @@ through version history.Share guides in whatever format fits your workflow:- **Video**: narrated walkthrough, mp4/H.264, with the cursor moving to each target+- **GIF**: short looping clip for a chat thread or an issue comment- **PDF**: print-ready, A4 portrait with auto page breaks- **DOCX**: open and keep editing in Word- **HTML**: self-contained, share anywhere, base64-embedded images- **Markdown**: paste into Notion, GitHub, internal docs, wikis+- **Mimik file**: the only format that imports back β see [Share a guide](#-share-a-guide) belowAll exports are generated client-side. Nothing touches a server.@@ -175,6 +178,37 @@ All exports are generated client-side. Nothing touches a server.</div>+### π¦ Share a guide++Export a guide as a **`.mimik` file** and someone else can import it into their own+Mimik β same steps, same screenshots, still editable, and still replayable with Guide+Me. It's a plain zip: a manifest, the screenshots, and a `README.md` so the file still+reads as a document to anyone without the extension.++It travels as a file, so sharing works the same way anything else does β email it, drop+it in Slack, commit it to a repo. There's no account and no server involved.++Because a guide can hold more than you meant to send, an export decides what leaves:++- **Blurred areas are burnt into the pixels** before the file is written, so the+ recipient has nothing to un-blur.+- **Text you typed into fields is removed** from the step text, title and links, not+ just from the stored value.+- **Links are trimmed to the page address** by default, dropping the query strings that+ carry session tokens.++Screenshots still show whatever was on screen when they were taken β use the blur tool+for anything sensitive that the camera caught.++To import, open the dashboard and click **Import**, or drop a `.mimik` file onto your+library. You'll see what the sender removed before anything is added.++<div align="right">++[![Back to top][back-to-top]](#readme-top)++</div>+## π Privacy & storageGuides, steps, and screenshots live on your device. There's no backend, no account, no telemetry. Your API keys (if you bring one) never leave your browser β they're stored locally and used to call the provider you chose directly.