-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
State of the branch after implementation is complete. (#15866)
* implement .NET implementation tutorial as the starter for the next module.
- Loading branch information
1 parent
150b2eb
commit 315b1df
Showing
21 changed files
with
923 additions
and
140 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Release History | ||
|
||
## 0.0.1-preview.1 (unreleased) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
|
||
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](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/template/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 App Configuration Learn client library for .NET | ||
|
||
## Getting started | ||
|
||
This section should include everything a developer needs to do to install and create their first client connection *very quickly*. | ||
|
||
### Install the package | ||
|
||
First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. | ||
|
||
### Prerequisites | ||
|
||
Include a section after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: | ||
|
||
> You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. | ||
### Authenticate the client | ||
|
||
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. | ||
|
||
## Key concepts | ||
|
||
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. | ||
|
||
## Examples | ||
|
||
|
||
## Troubleshooting | ||
|
||
## Next steps | ||
|
||
* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. | ||
* If appropriate, point users to other packages that might be useful. | ||
* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. | ||
|
||
## Contributing | ||
|
||
This is a template, but your SDK readme should include details on how to contribute code to the repo/package. | ||
|
||
<!-- LINKS --> | ||
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization | ||
[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 | ||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) |
Oops, something went wrong.