Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
erich-wang committed Jun 9, 2020
1 parent b2cac5f commit 9239000
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Use the guidelines in each section of this template to ensure consistency and re
* 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](#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](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/)

> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully.
Expand All @@ -26,9 +27,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/compute/Azure.ResourceManager.Compute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/eventhub/Azure.ResourceManager.EventHubs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/keyvault/Azure.ResourceManager.KeyVault/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/network/Azure.ResourceManager.Network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/resources/Azure.ResourceManager.Resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down
4 changes: 2 additions & 2 deletions sdk/storage/Azure.ResourceManager.Storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr

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.

Include a **Prerequisites** line 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:
### Prerequisites

**Prerequisites**: 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.
* You must have an [Azure subscription](https://azure.microsoft.com/free/)

### Authenticate the client

Expand Down

0 comments on commit 9239000

Please sign in to comment.