-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Description
The following libraries have the content of the Readme.md with the actual guidelines of the readme and these should be cleaned up with relevant introduction for the particular libraies -
This is the content that is pulled from the template readme and should be replaced with relevant content for the individual libraries -
README.md template
Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See Azure.Template/README.md for an example following this template.
Title: The H1 of your README should be in the format: # [Product Name] client library for [Language]
- All headings, including the H1, should use sentence-style capitalization. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information.
- Example:
# Azure Batch client library for Python
Azure Template client library for .NET
Introduction: The introduction appears directly under the title (H1) of your README.
-
DO NOT use an "Introduction" or "Overview" heading (H2) for this section.
-
First sentence: Describe the service briefly. You can usually use the first line of the service's docs landing page for this (Example: Cosmos DB docs landing page).
-
Next, add a bulleted list of the most common tasks supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the Examples section later in the document. Keep the task list short but include those tasks most developers need to perform with your package.
-
Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi):
Source code | Package (PyPi) | API reference documentation | Product documentation
