tabby-profile-share 0.1.3 → 0.1.4

package/CHANGELOG.md

@@ -2,22 +2,26 @@
 
 ## Unreleased
 
-## 0.1.3 — Installation compatibility fix (pending npm publication)
+## 0.1.4 — Documentation, discovery and GitHub release (2026-10-24)
 
-- Fixed `ERESOLVE` on Tabby 1.0.235 when other installed plugins declare incompatible Angular peer dependencies (for example, `tabby-save-output@3.1.0` requires Angular 4).
-- Removed *runtime peerDependencies* for Angular/Tabby host modules. These modules are provided by Tabby's own runtime; Angular 15 and Tabby API packages remain development-only dependencies for compilation.
-- Added a package integration test using Tabby's npm Arborist installer with the legacy plugin already installed. Export/import features are unchanged.
+- Improve npm package description and focused discovery keywords for SSH profile export/import.
+- Refresh English and Brazilian Portuguese READMEs with public npm install instructions, badges and release links.
+- Remove maintainer-only GitHub Actions publishing instructions from both READMEs (the publishing guide remains under `docs/`).
+- Add a fully synthetic Tabby YAML config with nested groups and 16 fake SSH profiles for screenshots, plus a privacy-focused capture guide.
+- No changes to the plugin's SSH import/export behavior or runtime dependencies.
 
+## 0.1.3 — Installation compatibility fix (2026-10-24)
 
+- Fixed npm `ERESOLVE` on Tabby 1.0.235 when other installed plugins declare incompatible Angular peer dependencies, such as `tabby-save-output@3.1.0`.
+- Removed runtime `peerDependencies` for Angular and Tabby host modules; development dependencies remain for compilation.
+- Added an integration test using Tabby's npm Arborist installer with the legacy plugin already installed.
+- First successful installation via the official Tabby plugin manager was confirmed by an early tester.
 
-- Open-source release preparation: MIT license, public documentation, security policy and contribution guidelines.
-- npm package metadata and release checklists.
+## 0.1.2 — First npm public preview (2026-10-24)
 
-## 0.1.2 — Prepared, not yet published to npm
-
-- Bump version for first public preview.
-- Review Git history and document Angular 15 compatibility/security advisory boundaries.
-- Add complete development audit visibility and npm name lookup to CI.
+- Published initial public npm version with MIT license and documentation.
+- Reviewed Git history and documented Angular 15 compatibility/security advisory boundaries.
+- Added build audit visibility and npm lookup in CI.
 
 ## 0.1.1 — Preview (2026-10-24)
 
@@ -27,7 +31,7 @@
 
 ## 0.1.0 — Development preview (2026-10-24)
 
-- Standalone settings plugin for Tabby.
+- Standalone settings plugin for official Tabby.
 - Selective SSH export with folder hierarchy and explicit username opt-in.
-- JSON sanitizer, append-only import and username prompt.
-- Unit tests for secrets, format validation and ID remapping.
+- Allowlist-based JSON sanitizer, append-only import and username prompt.
+- Unit tests for secret exclusions, format validation and ID remapping.

package/README.md

@@ -4,12 +4,16 @@
 
 [![CI](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml/badge.svg)](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/tabby-profile-share.svg)](https://www.npmjs.com/package/tabby-profile-share)
+[![npm downloads](https://img.shields.io/npm/dm/tabby-profile-share.svg)](https://www.npmjs.com/package/tabby-profile-share)
 
 [Português (Brasil)](README.pt-BR.md)
 
 Tabby Profile Share is an **independent, community-maintained plugin** for [Tabby by Eugeny](https://github.com/Eugeny/tabby). It does **not** modify Tabby, require the Tabby Performance fork, or have any affiliation with or endorsement from the Tabby maintainers.
 
-> **Status:** Preview 0.1.3 (unpublished) — manual installation and SSH export confirmed by an early tester. Wider compatibility, import scenarios and public npm publication remain separate validation steps. Do not assume all Tabby versions have been tested.
+**Available on npm:** [tabby-profile-share](https://www.npmjs.com/package/tabby-profile-share) · [GitHub releases](https://github.com/gugahartmann/Tabby_Profile_Share/releases) · [Report an issue](https://github.com/gugahartmann/Tabby_Profile_Share/issues/new/choose).
+
+Tested with the official Tabby **1.0.235** plugin manager on Windows for installation; broader host versions and end-to-end import flows require continued community testing.
 
 ## Features
 
@@ -29,19 +33,17 @@ The file contains **no stored credentials**, private key paths or login scripts.
 
 ## Installation compatibility
 
-Version 0.1.3 removes runtime Angular/Tabby peer requirements to prevent npm `ERESOLVE` when legacy plugins (e.g., `tabby-save-output@3.1.0` with Angular 4) are present. Tabby itself supplies Angular and the Tabby APIs when loading plugins. This change does not remove required development dependencies from the project, and does not fix security issues in legacy plugins.
+Versions 0.1.3+ remove runtime Angular/Tabby peer requirements to prevent npm `ERESOLVE` when legacy plugins (e.g., `tabby-save-output@3.1.0` with Angular 4) are present. Tabby itself supplies Angular and the Tabby APIs when loading plugins. This change does not remove required development dependencies from the project, and does not fix security issues in legacy plugins.
 
 ## Install
 
-### Once the package is available on npm
-
-Open **Tabby → Settings → Plugins**, search for **profile-share**, install `tabby-profile-share`, and restart Tabby if requested. Tabby discovers community plugins distributed with the `tabby-plugin` npm keyword.
+Open **Tabby → Settings → Plugins → Available**, search for **profile-share**, select `tabby-profile-share`, click **Get**, and restart Tabby when prompted. The plugin is distributed through [npm](https://www.npmjs.com/package/tabby-profile-share) and does **not** require cloning this repository. The Tabby search ranking may place new plugins near the bottom of results. Once installed, open **Settings → Profile Sharing**.
 
-**Not yet published to npm:** Until the package appears in npm search, use the preview instructions below. Publishing status should not be inferred from this README.
+If you prefer a compiled, standalone package, check [GitHub Releases](https://github.com/gugahartmann/Tabby_Profile_Share/releases). The manual Windows option remains available below.
 
-### Preview: manual install on Windows
+### Alternative: manual install on Windows
 
-1. Download the latest compiled ZIP from [Actions](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml) (or a future GitHub release).
+1. Download the **compiled plugin ZIP** from [Releases](https://github.com/gugahartmann/Tabby_Profile_Share/releases) or [Actions](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml).
 2. The Actions artifact contains another ZIP with a top-level directory called `tabby-profile-share`. Extract that directory.
 3. Close Tabby fully, including the tray icon, and copy the folder to:
    `%APPDATA%\tabby\plugins\node_modules\tabby-profile-share\`
@@ -50,6 +52,12 @@ Open **Tabby → Settings → Plugins**, search for **profile-share**, install `
 
 Do not install the directory one level too high, or nest `tabby-profile-share` twice.
 
+## Screenshots and demo profiles
+
+For screenshots, use the [**synthetic Tabby YAML configuration**](examples/demo-profiles.yaml) containing **16 example SSH profiles across nested regions, core/access networks and data centers**. All hosts use the reserved documentation IPv4 ranges or `.invalid` domains; there are **no real devices or credentials**.
+
+See the [screenshot guide](docs/SCREENSHOTS.md) to set up an isolated instance and capture the folder selector, username opt-in and import preview. **Do not replace your real `config.yaml` or upload an unredacted screenshot of production profiles.** Screenshots will be embedded in this README once captured and reviewed.
+
 ## Use
 
 **Export:** Select the folder tree, review the list of usernames (unchecked by default), explicitly enable only shared/team usernames, then click **Export**. Inspect the resulting JSON before distributing it.
@@ -58,12 +66,6 @@ Do not install the directory one level too high, or nest `tabby-profile-share` t
 
 See the [functional specification](docs/SPEC.md) for detailed behavior. Import has automated unit coverage, but full UI regression across Tabby releases remains on the roadmap.
 
-## Publish via GitHub Actions (no local Git or Node.js required)
-
-Maintainers can prepare npm releases entirely in the browser with the **Stage npm package** workflow. The first release uses a temporary npm stage-only token in the repository secret `NPM_STAGE_TOKEN`; subsequent releases use npm Trusted Publishing (OIDC) with no permanent token. Every release is reviewed and approved on npmjs.com with 2FA before it goes live.
-
-See the [complete step-by-step npm GitHub Actions guide](docs/PUBLISHING.md). Publishing is manual and never triggered by pushes or pull requests.
-
 ## Development
 
 Requirements: Node.js 22 and npm.
@@ -79,7 +81,7 @@ npm pack --dry-run
 
 The production entry point is `dist/index.js`. Angular and Tabby dependencies are external to the generated bundle, loaded by the host Tabby application.
 
-The repository includes CI for unit tests, compilation and packaging. Before a public release, verify the packaged files, audit dependencies, and test import twice on a disposable Tabby configuration.
+The repository includes CI for unit tests, compilation, packaging, and compatibility with legacy Tabby plugins. Use a disposable Tabby configuration when testing imports. Project release procedures are documented in [docs/PUBLISHING.md](docs/PUBLISHING.md).
 
 ## Feedback and issue reports
 

package/README.pt-BR.md

@@ -4,12 +4,16 @@
 
 [![CI](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml/badge.svg)](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml)
 [![Licença MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Versão npm](https://img.shields.io/npm/v/tabby-profile-share.svg)](https://www.npmjs.com/package/tabby-profile-share)
+[![Downloads npm](https://img.shields.io/npm/dm/tabby-profile-share.svg)](https://www.npmjs.com/package/tabby-profile-share)
 
 [English](README.md)
 
 O **Tabby Profile Share** é um plugin **independente, mantido pela comunidade**, compatível com o [Tabby do Eugeny](https://github.com/Eugeny/tabby). Não exige o fork Tabby Performance nem modifica o código original do Tabby.
 
-> **Estado:** Preview 0.1.3 (ainda não publicada). A instalação manual e a exportação foram confirmadas em teste inicial. A compatibilidade entre versões e todos os fluxos de importação ainda precisam de testes adicionais. O pacote ainda não foi publicado no npm.
+**Publicado no npm:** [tabby-profile-share](https://www.npmjs.com/package/tabby-profile-share) · [Releases no GitHub](https://github.com/gugahartmann/Tabby_Profile_Share/releases) · [Abrir issue](https://github.com/gugahartmann/Tabby_Profile_Share/issues/new/choose).
+
+Instalação via gerenciador de plugins confirmada no Tabby oficial **1.0.235**, Windows. A compatibilidade com outras versões e cenários completos de importação continua em validação.
 
 ## Funcionalidades
 
@@ -25,19 +29,17 @@ O **Tabby Profile Share** é um plugin **independente, mantido pela comunidade**
 
 ## Compatibilidade da instalação
 
-A versão 0.1.3 remove as restrições de `peerDependencies` de execução para Angular e APIs do Tabby. Isso evita o erro `ERESOLVE` causado por plugins legados como `tabby-save-output@3.1.0` (Angular 4), pois o Tabby já oferece Angular e seus módulos internamente. As dependências de desenvolvimento continuam presentes para compilar e testar o código. Nenhuma configuração ou credencial SSH é alterada.
+A partir da versão 0.1.3, o plugin remove as restrições de `peerDependencies` de execução para Angular e APIs do Tabby. Isso evita o erro `ERESOLVE` causado por plugins legados como `tabby-save-output@3.1.0` (Angular 4), pois o Tabby já oferece Angular e seus módulos internamente. As dependências de desenvolvimento continuam presentes para compilar e testar o código. Nenhuma configuração ou credencial SSH é alterada.
 
 ## Instalação
 
-### Pelo próprio Tabby (após publicação no npm)
-
-Abra **Settings → Plugins**, procure **profile-share** / `tabby-profile-share`, instale o pacote e reinicie, se solicitado.
+No Tabby, abra **Settings → Plugins → Available**, pesquise **profile-share**, encontre `tabby-profile-share`, clique em **Get** e reinicie se solicitado. O plugin está no [npm](https://www.npmjs.com/package/tabby-profile-share), sem necessidade de instalar Git ou compilar manualmente. Por conta do ranking da busca, plugins recentes podem aparecer no final da lista. Depois, abra **Settings → Profile Sharing**.
 
-O plugin ainda **não está publicado no npm**. Até lá, use o pacote compilado:
+Também oferecemos arquivos compilados em [Releases](https://github.com/gugahartmann/Tabby_Profile_Share/releases) para instalação manual.
 
 ### Instalação manual — Windows
 
-1. Acesse [GitHub Actions](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml), escolha uma execução aprovada e baixe o ZIP do plugin.
+1. Baixe o ZIP compilado em [GitHub Releases](https://github.com/gugahartmann/Tabby_Profile_Share/releases) ou em [GitHub Actions](https://github.com/gugahartmann/Tabby_Profile_Share/actions/workflows/test.yml).
 2. Extraia a pasta `tabby-profile-share` que está dentro do ZIP do pacote.
 3. Feche completamente o Tabby, inclusive a bandeja.
 4. Copie para:
@@ -47,6 +49,12 @@ O plugin ainda **não está publicado no npm**. Até lá, use o pacote compilado
 
 Evite colocar a pasta diretamente em `plugins` ou aninhar duas pastas `tabby-profile-share`.
 
+## Capturas de tela com perfis demonstrativos
+
+Para capturar a interface sem expor equipamentos da rede real, utilize o [**arquivo YAML de demonstração**](examples/demo-profiles.yaml), com **16 conexões SSH fictícias** agrupadas por regiões, backbone, acesso e data centers. Os hosts usam endereços de documentação ou domínios `.invalid`, sem credenciais.
+
+Siga o [guia de screenshots](docs/SCREENSHOTS.md) para preparar uma instância de teste e fotografar a seleção de pastas, autorização de usernames e prévia de importação. **Não substitua seu `config.yaml` real.** As capturas serão incorporadas ao README depois de registradas e revisadas.
+
 ## Como utilizar
 
 **Exportação:** marque as pastas e equipamentos que deseja compartilhar, selecione apenas os usuários SSH de equipe que devem acompanhar o arquivo e clique em **Export**.
@@ -59,12 +67,6 @@ Acesse [Nova issue](https://github.com/gugahartmann/Tabby_Profile_Share/issues/n
 
 **Nunca anexe exports reais, endereços IP internos, nomes de equipamentos de produção, chaves, senhas ou logs sem anonimização.** Para falhas de segurança, siga [SECURITY.md](SECURITY.md).
 
-## Publicação pelo GitHub Actions (sem Git ou Node.js local)
-
-O mantenedor pode publicar usando somente o navegador: **GitHub → Actions → Stage npm package**. A primeira publicação exige um token npm temporário de **stage only** armazenado no Secret `NPM_STAGE_TOKEN`. As próximas versões usam Trusted Publishing (OIDC) sem token permanente. Cada versão passa por aprovação na interface do npm com 2FA.
-
-Confira o [guia completo de publicação via GitHub Actions](docs/PUBLISHING.md). Nenhuma publicação é disparada automaticamente por commits ou PRs.
-
 ## Desenvolvimento
 
 ```bash

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "tabby-profile-share",
-  "version": "0.1.3",
-  "description": "Safe SSH profile sharing plugin for official Eugeny Tabby",
+  "version": "0.1.4",
+  "description": "Export, import and share SSH profiles and folder hierarchies in Tabby Terminal without sharing credentials or private keys.",
   "keywords": [
     "tabby-plugin",
     "tabby",
+    "tabby-terminal",
+    "terminal",
     "ssh",
-    "profiles"
+    "ssh-profiles",
+    "ssh-connections",
+    "profile-sharing",
+    "profile-export",
+    "profile-import",
+    "connection-manager",
+    "ssh-profile-manager"
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",