Skip to content

Commit 4d68583

Browse files
authored
Update package-readme-on-nuget-org.md (#3217)
1 parent 92c7cf6 commit 4d68583

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/nuget-org/package-readme-on-nuget-org.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Consider including the following items in your readme:
2929

3030
Keep in mind, high quality readmes can come in a wide variety of formats, shapes, and sizes! If you already have a package available on NuGet.org, chances are that you already have a `readme.md` or other documentation file in your repository that would be a great addition to your NuGet.org details page.
3131

32+
> [!Note]
33+
> Read through our [blog on writing a high-quality README](https://devblogs.microsoft.com/nuget/write-a-high-quality-readme-for-nuget-packages/) for some best practices.
34+
3235
## Preview your readme
3336

3437
To preview your readme file before it's live on NuGet.org, upload your package using the [Upload Package web portal on NuGet.org](/nuget/nuget-org/publish-a-package#web-portal-use-the-upload-package-tab-on-nugetorg) and scroll down to the "Readme File" section of the metadata preview. It should look something like this:

0 commit comments

Comments
 (0)