You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/coding-guidelines/libraries-packaging.md
+39-3Lines changed: 39 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,11 +55,47 @@ Packages can include a Markdown Readme file with a short usage documentation. To
55
55
The package Readme is displayed on the package details page on [NuGet gallery](https://nuget.org/). You can include the following content in it:
56
56
57
57
- A description of the package purpose.
58
+
- A list of package key features
59
+
- A code example that demostrates how to use the package.
58
60
- Information when package should be used. For example, if the library is included in the shared framework in .NET, but needs to be installed via NuGet on .NET Framework, it should be mentioned.
59
-
- Information on how to get started with the package.
60
-
- Links to related documentation.
61
61
- A list of common entry-point types for the package, with links to their API docs under [.NET API Browser](https://learn.microsoft.com/dotnet/api/).
62
-
- A short code example that demostrates the package usage.
62
+
- Links to related documentation.
63
+
- Information about how to provide feedback on the package and contribute to it.
64
+
65
+
Use the following Markdown template for a package Readme:
66
+
67
+
```
68
+
## About
69
+
70
+
<!-- A description of the package and where one can find more documentation -->
71
+
72
+
## Key Features
73
+
74
+
<!-- The key features of this package -->
75
+
76
+
## How to Use
77
+
78
+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
79
+
80
+
## Main Types
81
+
82
+
<!-- The main types provided in this library -->
83
+
84
+
## Additional Documentation
85
+
86
+
* [Conceptual documentation](...)
87
+
* [API documentation](...)
88
+
89
+
## Related Packages
90
+
91
+
<!-- The related packages associated with this package -->
92
+
93
+
## Feedback & Contributing
94
+
95
+
<!-- How to provide feedback on this package and contribute to it -->
96
+
97
+
ExamplePackage is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
98
+
```
63
99
64
100
For a list of supported Markdown features, see [NuGet documentation](https://learn.microsoft.com/nuget/nuget-org/package-readme-on-nuget-org#supported-markdown-features).
0 commit comments