Leesmij-pakket op NuGet.org

Neem een leesmij-bestand op in uw NuGet-pakket om uw pakketdetails uitgebreider en informatiever te maken voor uw gebruikers.

Dit is waarschijnlijk een van de eerste elementen die gebruikers zien wanneer ze uw pagina met pakketgegevens op NuGet.org bekijken en essentieel is om een goede indruk te maken!

Wat moet mijn readme-bestand bevatten?

Overweeg de volgende items op te nemen in uw leesmij-bestand:

• Een inleiding tot wat uw pakket is en doet - welke problemen lost het op?
• Hoe aan de slag te gaan met uw pakket- zijn er specifieke vereisten?
• Koppelingen naar uitgebreidere documentatie indien deze niet zijn opgenomen in het leesmij-bestand zelf.
• Ten minste een paar codefragmenten/voorbeelden of voorbeeldafbeeldingen.
• Waar en hoe u feedback kunt geven, zoals een koppeling naar de projectproblemen, Twitter, bugtracker of een ander platform.
• Hoe kan ik bijdragen, indien van toepassing.

U kunt bijvoorbeeld beginnen met deze README-sjabloon voor het pakket:

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

Houd er rekening mee dat kwalitatieve readmes in allerlei verschillende formaten, vormen en maten kunnen voorkomen! Als er al een pakket beschikbaar is op NuGet.org, is de kans groot dat u al een readme.md of ander documentatiebestand in uw opslagplaats hebt dat een uitstekende aanvulling is op de pagina met NuGet.org details.

Voorproefje van uw readme bekijken

Als u een voorbeeld van uw readme-bestand wilt bekijken voordat het live is op NuGet.org, uploadt u uw pakket met behulp van de webportal Pakket uploaden op NuGet.org en scrolt u naar de sectie Readme-bestand in de metagegevenspreview. Het ziet er ongeveer als volgt uit:

Neem de tijd om uw leesmij-bestand te controleren op compatibiliteit voor afbeeldingen en ondersteunde opmaak, zodat het een geweldige eerste indruk maakt op potentiële gebruikers. Als u fouten in het leesmij-bestand van het pakket wilt corrigeren nadat het is gepubliceerd naar NuGet.org, moet u een bijgewerkte pakketversie pushen met de oplossing. Zorg ervoor dat alles er van tevoren goed uitziet, kan u hoofdpijn besparen.

Toegestane domeinen voor afbeeldingen en badges

Vanwege beveiligings- en privacyproblemen beperkt NuGet.org de domeinen van waaruit afbeeldingen en badges kunnen worden weergegeven naar vertrouwde hosts.

NuGet.org kan alle afbeeldingen, inclusief badges, van de volgende vertrouwde domeinen worden weergegeven:

• 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

Als u denkt dat er een ander domein moet worden toegevoegd aan de acceptatielijst, kunt u gerust een probleem indienen en wordt dit beoordeeld door ons technische team voor privacy- en beveiligingsnaleving. Afbeeldingen met relatieve lokale paden en afbeeldingen die worden gehost vanaf niet-ondersteunde domeinen, worden niet weergegeven en genereren een waarschuwing in de preview van het readme-bestand en de pakketdetailpagina, die alleen zichtbaar is voor de pakketeigenaren.

Ondersteunde Markdown-functies

Markdown is een lichtgewicht opmaakcodetaal met een syntaxis voor platte tekst. NuGet.org readmes ondersteunen CommonMark-compatibele Markdown via de Markdig-parsing-engine.

NuGet.org ondersteunt momenteel de volgende Markdown-functies:

• Kopteksten
• Afbeeldingen
• Extra nadruk
• Lijsten
• Links
• Aanhalingstekens blokkeren
• Backslash-escapes
• Codefragmenten
• Takenlijsten
• Tabellen
• Emoji's
• Automatische koppelingen

We ondersteunen ook het markeren van syntaxis. U kunt een taal-id toevoegen om syntaxismarkeringen in uw codebereiken in te schakelen.