Paketlesedatei auf NuGet.org

Fügen Sie eine Infodatei in Ihr NuGet-Paket ein, um Ihre Paketdetails für Ihre Benutzer aussagekräftiger und informativer zu gestalten!

Dies ist wahrscheinlich eines der ersten Elemente, die Benutzer sehen werden, wenn sie ihre Seite mit den Paketdetails auf NuGet.org anzeigen und wichtig ist, um einen guten Eindruck zu erzielen!

Was sollte meine Readme-Datei enthalten?

Erwägen Sie das Einschließen der folgenden Elemente in Ihre Readme-Datei:

• Eine Einführung in das, was Ihr Paket ist und macht - welche Probleme lösen es?
• Wie können Sie mit Ihrem Paket beginnen – gibt es bestimmte Anforderungen?
• Links zu umfassenderen Dokumentationen, wenn sie nicht in der Infodatei selbst enthalten sind.
• Mindestens ein paar Codeausschnitte/Beispiele oder Beispielbilder.
• Wo und wie Sie Feedback hinterlassen, z. B. Link zu den Projektproblemen, Twitter, Fehler-Tracker oder einer anderen Plattform.
• Wie sie beisteuern, falls zutreffend.

Sie können z. B. mit dieser Paket-README-Vorlage beginnen:

# 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.

Beachten Sie, dass qualitativ hochwertige Readme-Dateien in einer Vielzahl von Formaten, Strukturen und Umfängen existieren können! Wenn Sie bereits über ein Paket auf NuGet.org verfügen, besteht die Wahrscheinlichkeit, dass Sie bereits über eine readme.md oder eine andere Dokumentationsdatei in Ihrem Repository verfügen, die eine großartige Ergänzung zu Ihrer NuGet.org Detailseite wäre.

Vorschau Ihrer README-Datei

Um eine Vorschau Ihrer Readme-Datei anzuzeigen, bevor sie auf NuGet.org live ist, laden Sie Ihr Paket über das Upload Package-Webportal auf NuGet.org hoch, und scrollen Sie nach unten zum Abschnitt "Readme File" der Metadatenvorschau. Das sollte in etwa so aussehen:

Nehmen Sie sich Zeit, ihre Readme-Datei für die Bildkonformität und unterstützte Formatierung zu überprüfen und in der Vorschau anzuzeigen, um sicherzustellen, dass es potenziellen Benutzern einen großen ersten Eindruck verleiht! Um Fehler bei der Paketlesedatei zu beheben, nachdem sie in NuGet.org veröffentlicht wurde, müssen Sie eine aktualisierte Paketversion mit der Korrektur pushen. Wenn Sie sicherstellen, dass alles im Voraus gut aussieht, können Sie Kopfschmerzen auf der Straße sparen.

Zulässige Domänen für Bilder und Abzeichen

Aufgrund von Sicherheits- und Datenschutzbedenken schränkt NuGet.org die Domains ein, von denen Bilder und Abzeichen nur auf vertrauenswürdigen Hosts gerendert werden können.

NuGet.org ermöglicht das Rendern aller Bilder, einschließlich Abzeichen, von den folgenden vertrauenswürdigen Domains:

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

Wenn Sie das Gefühl haben, dass eine weitere Domain der Zulassungsliste hinzugefügt werden sollte, können Sie gerne ein Problem einreichen, und es wird von unserem Entwicklungsteam auf Datenschutz- und Sicherheitscompliance überprüft. Bilder mit relativen lokalen Pfaden und Bildern, die von nicht unterstützten Domänen gehostet werden, werden nicht gerendert und erzeugen eine Warnung auf der Infodateivorschau- und Paketdetailsseite, die nur für die Paketbesitzer sichtbar ist.

Unterstützte Markdown-Features

Markdown ist eine schlanke Markupsprache mit Nur-Text-Formatierungssyntax. NuGet.org Readmes unterstützen CommonMark-kompatible Markdown über das Markdig-Analysemodul .

NuGet.org unterstützt derzeit die folgenden Markdown-Features:

• Kopfzeilen
• Bilder
• Zusätzliche Betonung
• Listen
• Verknüpfungen
• Anführungszeichen blockieren
• Backslash-Escapes
• Codespanne
• Aufgabenlisten
• Tabellen
• Emojis
• Automatische Verknüpfungen

Wir unterstützen auch die Syntaxmarkierung, Sie können einen Sprachbezeichner hinzufügen, um die Syntaxmarkierung in Ihren Codespannen zu ermöglichen.