Skip to content

Add README badges and a package-selection table for the 10 published packages #10

Closed

Description

@rd-rtca

Problem

README.md is packed into every one of the 10 packages via <PackageReadmeFile>README.md</PackageReadmeFile>, so it is the NuGet.org landing page for all of them. Two gaps hurt it in that role:

1. No badges. The file opens straight into a heading:

# MessageValidation

A **protocol-agnostic message validation pipeline** for .NET — ...

There is no NuGet version, download count, build status, or license badge. These are the signals a developer scans in the first two seconds to judge whether a library is alive and safe to depend on. Their absence reads as abandonment even when CI is green and the package is current.

2. No package-selection table. The repository ships 10 packages, but the Installation section shows only:

dotnet add package MessageValidation

Someone arriving because they need Kafka validation has to read the whole README, or browse the repository tree, to discover that MessageValidation.Kafka exists. Since each package's NuGet page renders this same README, a visitor on the MessageValidation.NatsNet page is told to install MessageValidation.

Proposed change

Badges immediately under the title:

[![NuGet](https://img.shields.io/nuget/v/MessageValidation.svg)](https://www.nuget.org/packages/MessageValidation/)
[![Downloads](https://img.shields.io/nuget/dt/MessageValidation.svg)](https://www.nuget.org/packages/MessageValidation/)
[![Build](https://github.com/Romain-OD/MessageValidation/actions/workflows/build.yml/badge.svg)](https://github.com/Romain-OD/MessageValidation/actions/workflows/build.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

The license badge should land together with the LICENSE file issue.

Package table in the Installation section:

Package Use it for
MessageValidation Core pipeline — always required
MessageValidation.RabbitMQ RabbitMQ consumers
MessageValidation.Kafka Kafka consumers
MessageValidation.MqttNet MQTT clients and brokers
MessageValidation.NatsNet NATS subscribers
MessageValidation.AzureServiceBus Azure Service Bus processors
MessageValidation.AzureEventHubs Azure Event Hubs processors
MessageValidation.FluentValidation Validate with FluentValidation
MessageValidation.DataAnnotations Validate with DataAnnotations
MessageValidation.ImmediateValidations Validate with Immediate.Validations

Pattern: pick one transport package, pick one validation package, both pull in the core.

Acceptance criteria

  • Badges render correctly on both GitHub and the NuGet.org package pages (absolute URLs only — relative image paths do not resolve on NuGet.org)
  • The package table lists all 10 packages with a one-line "use it for"
  • The Installation section makes clear that the core package alone is not enough for a specific transport
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions