🎬 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): keep features to the clips and move the rest where it reads
Luis Ortizd2f94a540fbb
diff --git a/README.es.md b/README.es.mdindex 2ea3c53..a54b7bf 100644--- a/README.es.md+++ b/README.es.md@@ -32,16 +32,13 @@ Le das a grabar, haces lo tuyo, y obtienes una guía pulida con capturas anotada- [📺 Demo](#-demo)- [👋 Empezar](#-empezar)- [✨ Funciones](#-funciones)- - [🎬 Captura automática](#-captura-automática)- - [📸 Capturas anotadas](#-capturas-anotadas)- [🔒 Smart Blur](#-smart-blur)- [🧠 Descripciones con IA (opcional)](#-descripciones-con-ia-opcional)- [▶️ Reproducción Guide Me](#️-reproducción-guide-me)- [🎙️ Narración por voz (opcional)](#️-narración-por-voz-opcional)- [✏️ Editor de guías](#️-editor-de-guías)- [📤 Exportación multi-formato](#-exportación-multi-formato)- - [🌍 Multi-idioma](#-multi-idioma)- - [💾 Almacenamiento local primero](#-almacenamiento-local-primero)+- [🔐 Privacidad y almacenamiento](#-privacidad-y-almacenamiento)- [🤝 Contribuir](#-contribuir)- [📜 Licencia](#-licencia)@@ -61,12 +58,18 @@ Mimik convierte cualquier tarea repetitiva del navegador en una guía documentadYa sea que estés documentando herramientas internas, escribiendo tutoriales de producto, o formando a un compañero, Mimik captura cada clic, tecla y navegación automáticamente para que te concentres en lo importante.+Cada acción relevante se convierte en un paso: clics en botones y enlaces, campos de formulario, atajos de teclado, acciones del portapapeles, arrastres y navegaciones. Los clics rápidos sobre elementos cercanos se agrupan para que las guías queden limpias, y el clic se intercepta antes de que la página navegue, así no se pierde nada en SPAs ni en cargas completas.++Cada paso lleva una captura con el elemento pulsado resaltado y ampliado. Sin recortar a mano, sin herramientas de anotación que aprender.+| Navegador | Versión | Instalación || --------- | ------- | ----------- || Chrome | [![Chrome Version][chrome-version-shield]][chrome-link] | [Chrome Web Store][chrome-link] || Firefox | [![Firefox Version][firefox-version-shield]][firefox-link] | [Firefox Add-ons][firefox-link] || Edge | [![Edge Version][edge-version-shield]][edge-link] | [Microsoft Edge Add-ons][edge-link] |+Disponible en inglés, español, portugués brasileño, francés y alemán. El idioma de las descripciones de IA se configura por separado, así que puedes usar Mimik en inglés y generar guías en español, o cualquier combinación.+> \[!IMPORTANT]>> **⭐️ Dale una estrella al repo** si Mimik te ahorra tiempo. Ayuda a que otras personas lo descubran.@@ -83,28 +86,6 @@ Ya sea que estés documentando herramientas internas, escribiendo tutoriales de## ✨ Funciones-### 🎬 Captura automática--Haces clic, escribes, navegas. Mimik lo ve todo. Cada acción relevante se convierte en un paso: clics en botones y enlaces, entradas de formulario, atajos de teclado, portapapeles, arrastrar y soltar, y navegaciones.--La fusión inteligente de eventos descarta los clics rápidos en elementos cercanos, para que tus guías queden limpias. La interceptación del clic ocurre *antes* de que la página cambie, así no se pierde nada en SPAs o recargas completas.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 📸 Capturas anotadas--Cada paso recibe una captura con el elemento resaltado y un zoom al área importante. Sin recortar a mano, sin aprender herramientas de anotación. Mimik descubre qué parte de la página importa y te la enmarca.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>-### 🔒 Smart BlurMimik detecta y difumina datos sensibles automáticamente en tus capturas: correos, teléfonos, números de identificación, tarjetas de crédito, IPs, direcciones MAC. Activa o desactiva cada categoría de forma independiente.@@ -193,17 +174,7 @@ Todas las exportaciones se generan del lado del cliente. Nada pasa por un servid</div>-### 🌍 Multi-idioma--Interfaz disponible en inglés, español, portugués brasileño, francés y alemán. El idioma de las descripciones de IA se configura por separado, así que puedes usar Mimik en inglés y generar guías en español, o cualquier combinación.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 💾 Almacenamiento local primero+## 🔐 Privacidad y almacenamientoTus guías, pasos y capturas viven en tu dispositivo. No hay backend, no hay cuenta, no hay telemetría. Tus API keys (si usas alguna) nunca salen del navegador. Se guardan localmente y se usan para llamar directo al proveedor que elegiste.diff --git a/README.fr.md b/README.fr.mdindex 8bac3b1..c7ee2cd 100644--- a/README.fr.md+++ b/README.fr.md@@ -32,16 +32,13 @@ Clique sur enregistrer, fais ce que tu as à faire, et récupère un guide soign- [📺 Démo](#-démo)- [👋 Pour commencer](#-pour-commencer)- [✨ Fonctionnalités](#-fonctionnalités)- - [🎬 Capture automatique](#-capture-automatique)- - [📸 Captures annotées](#-captures-annotées)- [🔒 Smart Blur](#-smart-blur)- [🧠 Descriptions par IA (optionnel)](#-descriptions-par-ia-optionnel)- [▶️ Lecture Guide Me](#️-lecture-guide-me)- [🎙️ Narration vocale (optionnel)](#️-narration-vocale-optionnel)- [✏️ Éditeur de guides](#️-éditeur-de-guides)- [📤 Export multi-format](#-export-multi-format)- - [🌍 Multilingue](#-multilingue)- - [💾 Stockage local d'abord](#-stockage-local-dabord)+- [🔐 Confidentialité et stockage](#-confidentialité-et-stockage)- [🤝 Contribuer](#-contribuer)- [📜 Licence](#-licence)@@ -61,12 +58,18 @@ Mimik transforme n'importe quelle tâche répétitive dans le navigateur en un gQue tu documentes des outils internes, que tu rédiges des tutoriels, ou que tu formes un collègue, Mimik capture chaque clic, frappe et navigation pour que tu puisses te concentrer sur le reste.+Chaque action utile devient une étape : clics sur les boutons et les liens, champs de formulaire, raccourcis clavier, actions du presse-papiers, glisser-déposer et navigations. Les clics rapprochés sur des éléments voisins sont fusionnés pour garder les guides propres, et le clic est intercepté avant que la page ne navigue, donc rien ne se perd sur les SPA ni sur les chargements complets.++Chaque étape reçoit une capture avec l'élément cliqué mis en évidence et zoomé. Pas de recadrage manuel, pas d'outil d'annotation à apprendre.+| Navigateur | Version | Installation || ---------- | ------- | ------------ || Chrome | [![Chrome Version][chrome-version-shield]][chrome-link] | [Chrome Web Store][chrome-link] || Firefox | [![Firefox Version][firefox-version-shield]][firefox-link] | [Firefox Add-ons][firefox-link] || Edge | [![Edge Version][edge-version-shield]][edge-link] | [Microsoft Edge Add-ons][edge-link] |+Disponible en anglais, espagnol, portugais brésilien, français et allemand. La langue des descriptions IA se règle séparément, donc tu peux lancer Mimik en anglais et générer les guides en français, ou n'importe quelle combinaison.+> \[!IMPORTANT]>> **⭐️ Mets une étoile au repo** si Mimik te fait gagner du temps. Ça aide les autres à le découvrir.@@ -83,28 +86,6 @@ Que tu documentes des outils internes, que tu rédiges des tutoriels, ou que tu## ✨ Fonctionnalités-### 🎬 Capture automatique--Tu cliques, tu tapes, tu navigues. Mimik voit tout. Chaque action utile devient une étape : clics sur boutons et liens, champs de formulaire, raccourcis clavier, presse-papiers, drag & drop, et navigations.--La fusion intelligente des événements écarte les clics rapprochés sur des éléments proches, pour garder tes guides propres. L'interception du clic se fait *avant* que la page ne change, donc rien ne se perd dans les SPA ou les rechargements complets.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 📸 Captures annotées--Chaque étape reçoit une capture avec l'élément cliqué mis en surbrillance et zoomé. Pas besoin de rogner à la main, pas d'outil d'annotation à apprendre. Mimik trouve la partie importante de la page et la cadre pour toi.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>-### 🔒 Smart BlurMimik détecte et floute automatiquement les données sensibles dans tes captures : e-mails, numéros de téléphone, numéros de sécu, cartes bancaires, IPs, adresses MAC. Active ou désactive chaque catégorie indépendamment.@@ -193,17 +174,7 @@ Tous les exports sont générés côté client. Rien ne passe par un serveur.</div>-### 🌍 Multilingue--Interface disponible en anglais, espagnol, portugais brésilien, français et allemand. La langue des descriptions IA se configure séparément, donc tu peux lancer Mimik en anglais et générer les guides en français, ou n'importe quelle combinaison.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 💾 Stockage local d'abord+## 🔐 Confidentialité et stockageTes guides, étapes et captures restent sur ton appareil. Pas de backend, pas de compte, pas de télémétrie. Tes clés API (si tu en utilises) ne quittent jamais le navigateur. Elles sont stockées localement et servent à appeler directement le fournisseur que tu as choisi.diff --git a/README.md b/README.mdindex 4622ca5..d9af99f 100644--- a/README.md+++ b/README.md@@ -32,16 +32,13 @@ Click record, do the thing, get a polished guide with annotated screenshots. Nar- [📺 Demo](#-demo)- [👋 Getting Started](#-getting-started)- [✨ Features](#-features)- - [🎬 Auto-capture](#-auto-capture)- - [📸 Annotated screenshots](#-annotated-screenshots)- [🔒 Smart Blur](#-smart-blur)- [🧠 AI descriptions (optional)](#-ai-descriptions-optional)- [▶️ Guide Me replay](#️-guide-me-replay)- [🎙️ Voice narration (optional)](#️-voice-narration-optional)- [✏️ Guide editor](#️-guide-editor)- [📤 Multi-format export](#-multi-format-export)- - [🌍 Multi-language](#-multi-language)- - [💾 Local-first storage](#-local-first-storage)+- [🔐 Privacy & storage](#-privacy--storage)- [🤝 Contributing](#-contributing)- [📜 License](#-license)@@ -61,12 +58,18 @@ Mimik turns any repetitive browser task into a documented, shareable guide in seWhether you're documenting internal tools, writing product tutorials, or onboarding a teammate, Mimik captures every click, keystroke, and navigation automatically so you can focus on the work.+Every meaningful action becomes a step: clicks on buttons and links, form inputs, keyboard shortcuts, clipboard actions, drag events, and page navigations. Rapid clicks on nearby elements are merged so guides stay clean, and clicks are intercepted before the page navigates away, so nothing is lost on SPAs or full page loads.++Each step gets a screenshot with the clicked element highlighted and zoomed in. No manual cropping, no annotation tools to learn.+| Browser | Version | Install || ------- | ------- | ------- || Chrome | [![Chrome Version][chrome-version-shield]][chrome-link] | [Chrome Web Store][chrome-link] || Firefox | [![Firefox Version][firefox-version-shield]][firefox-link] | [Firefox Add-ons][firefox-link] || Edge | [![Edge Version][edge-version-shield]][edge-link] | [Microsoft Edge Add-ons][edge-link] |+Available in English, Spanish, Brazilian Portuguese, French, and German. The AI description language is set separately, so you can run Mimik in English and generate guides in Spanish, or any combination.+> \[!IMPORTANT]>> **⭐️ Star the repo** if Mimik saves you time. It helps other people discover it!@@ -83,28 +86,6 @@ Whether you're documenting internal tools, writing product tutorials, or onboard## ✨ Features-### 🎬 Auto-capture--Click, type, navigate. Mimik watches it all. Every meaningful action becomes a step: clicks on buttons and links, form inputs, keyboard shortcuts, clipboard actions, drag events, and page navigations.--Smart event merging deduplicates rapid clicks on nearby elements, so your guides stay clean. Click interception fires *before* the page navigates away, so nothing gets lost during SPAs or full page loads.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 📸 Annotated screenshots--Every step gets a screenshot with the clicked element highlighted and zoomed in. No manual cropping, no annotation tools to learn. Mimik figures out the important part of the page and frames it for you.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>-### 🔒 Smart BlurMimik automatically detects and blurs sensitive data in your screenshots: emails, phone numbers, SSNs, credit cards, IP addresses, MAC addresses. Toggle each category independently.@@ -193,17 +174,7 @@ All exports are generated client-side. Nothing touches a server.</div>-### 🌍 Multi-language--UI available in English, Spanish, Brazilian Portuguese, French, and German. The AI description language is configurable independently, so you can run Mimik in English but generate guides in Spanish, or any combination.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 💾 Local-first storage+## 🔐 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.diff --git a/README.pt-BR.md b/README.pt-BR.mdindex 704555f..364497b 100644--- a/README.pt-BR.md+++ b/README.pt-BR.md@@ -32,16 +32,13 @@ Clica em gravar, faz o que precisa, e recebe um guia caprichado com capturas de- [📺 Demo](#-demo)- [👋 Começando](#-começando)- [✨ Funcionalidades](#-funcionalidades)- - [🎬 Captura automática](#-captura-automática)- - [📸 Capturas anotadas](#-capturas-anotadas)- [🔒 Smart Blur](#-smart-blur)- [🧠 Descrições por IA (opcional)](#-descrições-por-ia-opcional)- [▶️ Reprodução Guide Me](#️-reprodução-guide-me)- [🎙️ Narração por voz (opcional)](#️-narração-por-voz-opcional)- [✏️ Editor de guias](#️-editor-de-guias)- [📤 Exportação multi-formato](#-exportação-multi-formato)- - [🌍 Multi-idioma](#-multi-idioma)- - [💾 Armazenamento local primeiro](#-armazenamento-local-primeiro)+- [🔐 Privacidade e armazenamento](#-privacidade-e-armazenamento)- [🤝 Contribuir](#-contribuir)- [📜 Licença](#-licença)@@ -61,12 +58,18 @@ O Mimik transforma qualquer tarefa repetitiva do navegador num guia documentadoSeja documentando ferramentas internas, escrevendo tutoriais do produto, ou integrando um colega novo, o Mimik captura cada clique, tecla e navegação automaticamente pra tu focar no que importa.+Cada ação relevante vira um passo: cliques em botões e links, campos de formulário, atalhos de teclado, ações da área de transferência, arrastos e navegações. Cliques rápidos em elementos próximos são agrupados pros guias ficarem limpos, e o clique é interceptado antes da página navegar, então nada se perde em SPAs nem em carregamentos completos.++Cada passo ganha uma captura com o elemento clicado destacado e ampliado. Sem recortar na mão, sem ferramenta de anotação pra aprender.+| Navegador | Versão | Instalação || --------- | ------ | ---------- || Chrome | [![Chrome Version][chrome-version-shield]][chrome-link] | [Chrome Web Store][chrome-link] || Firefox | [![Firefox Version][firefox-version-shield]][firefox-link] | [Firefox Add-ons][firefox-link] || Edge | [![Edge Version][edge-version-shield]][edge-link] | [Microsoft Edge Add-ons][edge-link] |+Disponível em inglês, espanhol, português brasileiro, francês e alemão. O idioma das descrições de IA é configurado separadamente, então tu pode usar o Mimik em inglês e gerar os guias em português, ou qualquer combinação.+> \[!IMPORTANT]>> **⭐️ Dá uma estrela no repo** se o Mimik te economiza tempo. Ajuda outras pessoas a descobrirem ele.@@ -83,28 +86,6 @@ Seja documentando ferramentas internas, escrevendo tutoriais do produto, ou inte## ✨ Funcionalidades-### 🎬 Captura automática--Clica, digita, navega. O Mimik vê tudo. Cada ação relevante vira um passo: cliques em botões e links, campos de formulário, atalhos de teclado, área de transferência, arrastar e soltar, e navegações.--A fusão inteligente de eventos descarta os cliques rápidos em elementos próximos, pra teus guias ficarem limpos. A interceptação do clique acontece *antes* da página mudar, então nada se perde em SPAs nem em recarregamentos completos.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 📸 Capturas anotadas--Cada passo ganha uma captura com o elemento clicado destacado e um zoom na área importante. Sem recortar na mão, sem aprender ferramentas de anotação. O Mimik descobre qual parte da página importa e enquadra ela pra ti.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>-### 🔒 Smart BlurO Mimik detecta e desfoca dados sensíveis automaticamente nas tuas capturas: e-mails, telefones, CPFs, cartões de crédito, IPs, endereços MAC. Liga ou desliga cada categoria do jeito que tu quiser.@@ -193,17 +174,7 @@ Todas as exportações são geradas no cliente. Nada passa por servidor.</div>-### 🌍 Multi-idioma--Interface disponível em inglês, espanhol, português brasileiro, francês e alemão. O idioma das descrições de IA é configurado separadamente, então tu pode usar o Mimik em inglês e gerar os guias em português, ou qualquer combinação.--<div align="right">--[![Back to top][back-to-top]](#readme-top)--</div>--### 💾 Armazenamento local primeiro+## 🔐 Privacidade e armazenamentoTeus guias, passos e capturas ficam no teu dispositivo. Sem backend, sem conta, sem telemetria. Tuas API keys (se tu usar alguma) nunca saem do navegador. Ficam salvas localmente e são usadas pra chamar direto o provedor que tu escolheu.