Compartir a través de

Léame del paquete en NuGet.org

Incluya un archivo léame en el paquete NuGet para enriquecer y hacer más informativos los detalles de su paquete para los usuarios.

Es probable que uno de los primeros elementos que los usuarios vean cuando vean la página de detalles del paquete en NuGet.org y es esencial para hacer una buena impresión!

Importante

NuGet.org solo admite el uso de archivos léame en Markdown e imágenes provenientes de un conjunto limitado de dominios. Consulte nuestros dominios permitidos para imágenes y características de Markdown compatibles para asegurarse de que el archivo README se muestre correctamente en NuGet.org.

¿Qué debe incluir mi archivo readme?

Considere incluir los siguientes elementos en el archivo readme:

  • Una introducción a lo que es el paquete y qué problemas soluciona?
  • ¿Cómo empezar a trabajar con el paquete? ¿Hay algún requisito específico?
  • Vínculos a documentación más completa si no se incluye en el propio archivo Léame.
  • Al menos algunos fragmentos de código o ejemplos o imágenes de ejemplo.
  • Dónde y cómo dejar comentarios, como el vínculo a los problemas del proyecto, Twitter, seguimiento de errores u otra plataforma.
  • Cómo contribuir, si procede.

Por ejemplo, puede empezar con esta plantilla LÉAME de paquete:

# Package readme title, e.g., display name or title of the package (optional)

Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves.

## Getting started

Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.

### Prerequisites

What are specific minimum requirements to use your packages? Consider excluding this section if your package works without any additional setup beyond simple package installation.

## Usage

Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable. 

- Provide sample code using code snippets
- Include screenshots, diagrams, or other visual help users better understand how to use your package

## Additional documentation

Provide links to more resources: List links such as detailed documentation, tutorial videos, blog posts, or any other relevant documentation to help users get the most out of your package.

## Feedback

Where and how users can leave feedback?

- Links to a GitHub repository where could open issues, Twitter, a Discord channel, bug tracker, or other platforms where a package consumer can connect with the package author.

Tenga en cuenta que los léames de alta calidad pueden tener una amplia variedad de formatos, formas y tamaños. Si ya tiene un paquete disponible en NuGet.org, es probable que ya tenga un readme.md archivo de documentación u otro archivo de documentación en el repositorio que sería una excelente adición a la página de detalles de NuGet.org.

Nota:

Lea nuestro blog sobre cómo escribir un ARCHIVO LÉAME de alta calidad para conocer algunas mejores prácticas.

Vista previa del archivo léame

Para obtener una vista previa del archivo Léame antes de que esté activo en NuGet.org, cargue el paquete mediante el portal web Cargar paquete en NuGet.org y desplácese hacia abajo hasta la sección "Archivo Léame" de la vista previa de metadatos. Debe tener el siguiente aspecto:

Vista previa del archivo Léame

Considere la posibilidad de tomar tiempo para revisar y obtener una vista previa del archivo léame para el cumplimiento de imágenes y el formato admitido para asegurarse de que ofrece una gran primera impresión a los posibles usuarios. Para corregir los errores en el archivo Léame de tu paquete una vez que esté publicado en NuGet.org, deberás subir una versión actualizada del paquete con la corrección. Asegurarse de que todo se ve bien con antelación puede ahorrarle dolor de cabeza por el camino.

Dominios permitidos para imágenes y distintivos

Debido a los problemas de seguridad y privacidad, NuGet.org restringe los dominios desde los que se pueden representar imágenes y distintivos en hosts de confianza.

NuGet.org permite representar todas las imágenes, incluidas las insignias, de los siguientes dominios de confianza:

  • api.codacy.com
  • app.codacy.com
  • api.codeclimate.com
  • api.dependabot.com
  • api.travis-ci.com
  • api.reuse.software
  • app.fossa.com
  • app.fossa.io
  • avatars.githubusercontent.com
  • badge.fury.io
  • badgen.net
  • badges.gitter.im
  • buildstats.info
  • caniuse.bitsofco.de
  • camo.githubusercontent.com
  • cdn.jsdelivr.net
  • cdn.syncfusion.com
  • ci.appveyor.com
  • circleci.com
  • codecov.io
  • codefactor.io
  • coveralls.io
  • dev.azure.com
  • flat.badgen.net
  • github.com/.../workflows/.../badge.svg
  • gitlab.com
  • img.shields.io
  • i.imgur.com
  • isitmaintained.com
  • opencollective.com
  • raw.github.com
  • raw.githubusercontent.com
  • snyk.io
  • sonarcloud.io
  • travis-ci.com
  • travis-ci.org
  • wakatime.com
  • user-images.githubusercontent.com

Si cree que se debe agregar otro dominio a la lista de permitidos, no dude en presentar un problema y nuestro equipo de ingeniería revisará el cumplimiento de la privacidad y la seguridad. Las imágenes con rutas de acceso locales relativas y aquellas hospedadas en dominios no admitidos no se representarán, y generarán una advertencia en la vista previa del archivo léame y en la página de detalles del paquete, la cual solo será visible para los dueños del paquete.

Características de Markdown admitidas

Markdown es un lenguaje de marcado ligero con sintaxis de texto sin formato. NuGet.org readmes admiten Markdown compatible con CommonMark a través del motor de análisis de Markdig .

NuGet.org admite actualmente las siguientes características de Markdown:

También ofrecemos resaltado de sintaxis. Puede agregar un identificador de lenguaje para habilitar el resaltado de sintaxis en sus fragmentos de código.