docs: refresh READMEs and add status badges#60
Merged
Conversation
Bring both READMEs in line with the shipped v1 (execution + history, NuGet-published importer) and add a badge row to each. Main README: - Add CI, latest-release, downloads, .NET 10, platform and licence badges. - Drop the stale "pre-1.0 software" caveat and the hard-coded "v1.0.0 is latest" line; rewrite Status as a version-agnostic v1 feature summary (badges/Releases now carry the current version number). - Add the `dotnet tool install` command to the SnipCommand import section. Importer README: - Add NuGet version, NuGet downloads, CI, .NET 10 and licence badges. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Embed the quick-start Home shot (CLI launcher, tag rail, most-used Snips with Copy/Run) near the top of the README, after the intro. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes both READMEs so they match the shipped v1, and adds a badge row to each.
Main README
dotnet tool install -g NextIteration.Snipdeck.Importercommand to the SnipCommand import section (the tool now ships on NuGet).Importer README
Verified the unchanged sections (Stack, Repository layout, Building, Acknowledgements, usage/options) against the current repo — package id, target frameworks, workflow names and licence all check out.
Docs-only; no app behaviour change, so no CHANGELOG entry.
🤖 Generated with Claude Code