Explain a developer product in its README

A repository visitor needs to understand what your product does before deciding whether to install it. Choose an explanation that matches the product: an API interaction for a library, a capability map for a platform, or separate routes for distinct jobs.

Apply the pattern

1. Write one sentence naming the intended user, their task and what the product makes possible.
2. Show one representative interaction or map the essential capabilities to concrete guides. Avoid an exhaustive feature inventory above the first useful action.
3. Name one default next step: try an example, create a project or choose a quickstart. Give alternatives labels that explain who needs them.
4. Ask a reader unfamiliar with the product to describe its purpose and find the starting route without your explanation.

Where judgment matters

Do not copy a mature platform's breadth into a narrow product. A collection of badges and feature names can conceal the actual programming model. These examples show presentation choices; they do not provide evidence that one choice increases conversion.