Overview
Git NuGet README solves a common packaging gap: the project ships a package, but the README reads like a placeholder or a generic repo intro. The skill pulls from source metadata, packable project structure, and git history so the final README speaks to adopters in terms of capability, fit, and honest constraints.
It does not market fantasy. The README is expected to stay grounded in what the package really exposes, how it is structured, and why somebody would choose it over a thinner or broader dependency.
Concepts
- Package-first framing: the README is written for the consumer deciding whether to adopt the package, not for the maintainer who already knows it.
- Metadata grounding: project files, package metadata, and repo history are the factual base.
- Adoption-minded writing: the copy should make selection easier without inventing features or vague promises.
- NuGet context over repo sprawl: the skill stays focused on the packable project that is actually published.
Usage guidance
Use this skill when a package README needs to be created from scratch, refreshed after significant changes, or tightened so the NuGet page becomes a better decision surface. It is ideal when the agent should inspect the real project rather than rewrite docs from memory.
The best results come from repositories where src/ contains a clear packable project and the recent git history explains what changed in the package’s positioning, API surface, or developer experience.