diff --git a/README.md b/README.md index 205d4ec..720c790 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,15 @@ # Snipdeck +

+ CI status + Latest release + Downloads + .NET 10 + Platform: Windows 11 + Licence: Apache-2.0 +

+ A native Windows desktop app for managing parameterised CLI command snippets ("Snips"), organised by the CLI they belong to. Browse a CLI, pick a Snip, fill its arguments, and copy the resolved command to the clipboard — or run it in place @@ -14,23 +23,34 @@ Conceptually inspired by difference: **the CLI is the top-level organising axis** — every Snip belongs to exactly one CLI (e.g. `pl-app`, `mpt-app`, `inv-app`). -> Snipdeck is pre-1.0 software. The list below describes what's actually -> implemented today, not what's planned. See [`TODO.md`](TODO.md) for the -> backlog and [`CHANGELOG.md`](CHANGELOG.md) for what's shipped. +

+ Snipdeck Home — the CLI launcher, tag rail and most-used Snips with Copy and Run actions +

## Status -**v1.0.0** is the latest release — see -[Releases](https://github.com/StuartMeeks/Snipdeck/releases). It contains the full -v1 feature set: browse CLIs and Snips, author Snips with structured parameters, fill -and copy resolved commands, global hotkey, system tray with close-to-tray, theme -switching, and Velopack-backed self-update. - -It also runs Snips: execute one in its configured shell via a real pseudo-terminal — -so colours, spinners, progress bars and interactive prompts all work — watch it live, -and keep a clean plain-text run history you can search and replay. Per-CLI shell, -executable path and working directory configure how runs launch. See -[`CHANGELOG.md`](CHANGELOG.md). +Snipdeck has shipped its **v1 release** and is stable — see +[Releases](https://github.com/StuartMeeks/Snipdeck/releases) for the current +build, or [`CHANGELOG.md`](CHANGELOG.md) for the full history. The installed app +self-updates from then on. + +The v1 feature set: + +- Browse CLIs and Snips; author Snips with structured Text and Choice parameters, + tags, favourites, and a Markdown description. +- Fill a Snip's parameters from a flyout with a live preview, and copy the resolved + command to the clipboard. +- **Run** a Snip in its configured shell via a real pseudo-terminal (ConPTY) — so + colours, spinners, progress bars and interactive prompts all work — watch it live, + and keep a clean, searchable plain-text run history you can replay. Per-CLI shell, + executable path and working directory configure how runs launch. +- Global hotkey (default **Ctrl+Alt+S**, rebindable), system tray with + configurable close-to-tray, Light/Dark/System theme, and per-write plus + pre-update store backups. +- Migrate from SnipCommand with the [`snipdeck-importer`](tools/Snipdeck.Importer) + .NET global tool. + +See [`TODO.md`](TODO.md) for the backlog of deferred and v2 ideas. ## Install @@ -75,8 +95,15 @@ interface defined in Core and implemented in App. Migrating from SnipCommand? The cross-platform `snipdeck-importer` console tool reads a SnipCommand export and merges its snippets into your Snipdeck store, -grouping them under a CLI per command. It defaults to a dry-run preview; see -[`tools/Snipdeck.Importer/README.md`](tools/Snipdeck.Importer/README.md). +grouping them under a CLI per command. It defaults to a dry-run preview. Install +it as a .NET global tool: + +```bash +dotnet tool install -g NextIteration.Snipdeck.Importer +``` + +See [`tools/Snipdeck.Importer/README.md`](tools/Snipdeck.Importer/README.md) for +the full options. ## Building diff --git a/docs/quick-start-shell.png b/docs/quick-start-shell.png new file mode 100644 index 0000000..029e4b8 Binary files /dev/null and b/docs/quick-start-shell.png differ diff --git a/tools/Snipdeck.Importer/README.md b/tools/Snipdeck.Importer/README.md index 08d112c..db5f5d5 100644 --- a/tools/Snipdeck.Importer/README.md +++ b/tools/Snipdeck.Importer/README.md @@ -1,5 +1,11 @@ # snipdeck-importer +[![NuGet](https://img.shields.io/nuget/v/NextIteration.Snipdeck.Importer)](https://www.nuget.org/packages/NextIteration.Snipdeck.Importer) +[![NuGet downloads](https://img.shields.io/nuget/dt/NextIteration.Snipdeck.Importer)](https://www.nuget.org/packages/NextIteration.Snipdeck.Importer) +[![CI status](https://github.com/StuartMeeks/Snipdeck/actions/workflows/ci.yml/badge.svg)](https://github.com/StuartMeeks/Snipdeck/actions/workflows/ci.yml) +[![.NET 10](https://img.shields.io/badge/.NET-10-512BD4?logo=dotnet&logoColor=white)](https://dotnet.microsoft.com/) +[![Licence: Apache-2.0](https://img.shields.io/badge/licence-Apache--2.0-blue)](../../LICENSE) + A small cross-platform console tool that imports command snippets from other tools into a [Snipdeck](../../README.md) store. The first supported source is **SnipCommand**; the design leaves room for more sources as subcommands later.