Skip to content

Commit f881f58

Browse files
Unify the wording in README for examples (#42)
* update readme * add colon * rename sample to example * update * update * update
1 parent 85c0175 commit f881f58

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

examples/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ These examples show how to use the JavaScript Provider for Azure App Configurati
44

55
## Prerequisites
66

7-
The sample programs are compatible with [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule).
7+
The examples are compatible with [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule).
88

9-
You need [an Azure subscription](https://azure.microsoft.com/free/) and the following Azure resources to run these sample programs:
9+
You need [an Azure subscription](https://azure.microsoft.com/free/) and the following Azure resources to run the examples:
1010

1111
- [Azure App Configuration store](https://learn.microsoft.com/en-us/azure/azure-app-configuration/quickstart-azure-app-configuration-create?tabs=azure-portal)
1212

13-
Samples retrieve credentials to access your App Configuration store from environment variables.
13+
The examples retrieve credentials to access your App Configuration store from environment variables.
1414
Alternatively, edit the source code to include the appropriate credentials.
15-
See each individual sample for details on which environment variables/credentials it requires to function.
15+
See each individual example for details on which environment variables/credentials it requires to function.
1616

1717
## Add a key-value
18-
Add the following key-value to the App Configuration store and leave Label and Content Type with their default values. For more information about how to add key-values to a store using the Azure portal or the CLI, go to [Create a key-value](./quickstart-azure-app-configuration-create.md#create-a-key-value).
18+
Add the following key-value to the App Configuration store and leave **Label** and **Content Type** with their default values. For more information about how to add key-values to a store using the Azure portal or the CLI, go to [Create a key-value](./quickstart-azure-app-configuration-create.md#create-a-key-value).
1919

2020
| Key | Value |
2121
|------------------------|----------------|
@@ -33,14 +33,14 @@ To run the examples using the published version of the package:
3333

3434
2. There are two ways to run the examples using correct credentials:
3535

36-
- Edit the file `.env.template`, adding the access keys to your App Configuration store. and rename the file from `.env.template` to just `.env`. The example programs will read this file automatically.
36+
- Edit the file `.env.template`, adding the access keys to your App Configuration store. and rename the file from `.env.template` to just `.env`. The examples will read this file automatically.
3737

3838
- Alternatively, you can set the environment variables to the access keys to your App Configuration store. In this case, setting up the `.env` file is not required.
3939
```bash
4040
npx cross-env APPCONFIG_CONNECTION_STRING="<appconfig connection string>"
4141
```
4242

43-
3. Run the example:
43+
3. Run the examples:
4444
```bash
4545
node helloworld.mjs
4646
```

0 commit comments

Comments
 (0)