sdk/template/.content/packageResource/README.md
This section should give out brief introduction of the client library.
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.
Source code | Package (NuGet) | API reference documentation | Product documentation
This section should include everything a developer needs to do to install and create their first client connection very quickly.
First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like dotnet add package package-name, but should enable a developer to successfully install the package from NuGet, npm, or even cloning a GitHub repository.
Install the client library for .NET with NuGet:
dotnet add package Azure.Template --prerelease
Include a section after the install command that details any requirements that must be satisfied before a developer can authenticate and test all of the snippets in the Examples section. For example, for Cosmos DB:
You must have an Azure subscription and Cosmos DB account (SQL API). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the .NET Core SDK 3.0 or higher with a language version of
latest. It is also possible to compile with the .NET Core SDK 2.1.x using a language version ofpreview.
If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating.
For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object.
The Key concepts section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity.
Include the Thread safety and Additional concepts sections below at the end of your Key concepts section. You may remove or add links depending on what your library makes use of:
We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.
Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime
<!-- CLIENT COMMON BAR -->You can familiarize yourself with different APIs using Samples.
You can create a client and call the client's <operation> method.
Console.WriteLine("Hello, world!");
Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery.
Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API.
If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code.
/samples directory.This is a template, but your SDK readme should include details on how to contribute code to the repo/package.
<!-- LINKS -->