Skip to content

Commit 08b7f0f

Browse files
authored
Add readme template (#3299)
* add readme template
1 parent 0540c98 commit 08b7f0f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,39 @@ Consider including the following items in your readme:
2727
* Where and how to leave feedback such as link to the project issues, Twitter, bug tracker, or other platform.
2828
* How to contribute, if applicable.
2929

30+
For example, you can start with this package README template:
31+
32+
```text
33+
# Package readme title, e.g., display name or title of the package (optional)
34+
35+
Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves.
36+
37+
## Getting started
38+
39+
Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.
40+
41+
### Prerequisites
42+
43+
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.
44+
45+
## Usage
46+
47+
Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable.
48+
49+
- Provide sample code using code snippets
50+
- Include screenshots, diagrams, or other visual help users better understand how to use your package
51+
52+
## Additional documentation
53+
54+
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.
55+
56+
## Feedback
57+
58+
Where and how users can leave feedback?
59+
60+
- 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.
61+
```
62+
3063
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.
3164

3265
> [!Note]

0 commit comments

Comments
 (0)