docs: refresh README for .NET 10 GA + diff/bandwidth features - #8
Merged
Conversation
- Drop '(preview)' from .NET 10 SDK link (GA'd Nov 2025) - Remove stale ASCII screenshots section - Expand 'What It Does' to cover the update-diff + bandwidth planner features (previously only manifest review was documented) - Add 'Compare Two Packages' CLI section with diff subcommand examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- docs/cli.md - full CLI reference (analyze + diff + rules subcommands, all flags, exit codes)
- docs/rules.md - catalog of every RuleId with default severity + rules.json override format
- docs/update-diff.md - block-hash math, comparepackage.exe parity, bandwidth planner formulas
- docs/security.md - threat model for handling untrusted MSIX packages
- docs/architecture.md - contributor map of the three-project solution
- docs/screenshots/{ui.png,cli.png} - real screenshots referenced from README
- README screenshots section now uses the real PNG filenames
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
What
(preview)from .NET 10 SDK link — .NET 10 went GA in November 2025diffsubcommand and bandwidth planner flagsWhy
The README was written when MSIXplainer was just a manifest reviewer. Since then v1.x added the full update-diff + fleet-rollout planner — which is the more unique feature — and the README didn't mention any of it.