Skip to content

Commit c4f879c

Browse files
authored
Update a few READMEs for release (#2170)
1 parent c8aad07 commit c4f879c

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

sdk/core/azure_core_amqp/README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# azure_core_amqp
1+
# Azure AMQP library for Rust
22

3-
Azure AMQP crate for consumption of AMQP based packages in the Azure SDK for C++.
3+
Azure AMQP crate for consumption of AMQP based packages in the Azure SDK for Rust and C++.
44

5-
NOTE: THIS IS NOT A GENERAL PURPOSE AMQP LIBRARY AND SHOULD NOT BE USED AS SUCH.
5+
> NOTE: THIS IS NOT A GENERAL PURPOSE AMQP LIBRARY AND SHOULD NOT BE USED AS SUCH.
66
77
This crate is part of a collection of crates: for more information please refer to [https://github.com/azure/azure-sdk-for-rust](https://github.com/azure/azure-sdk-for-rust).
88

9-
## Testing the AMQP Client.
9+
## Testing the AMQP Client
1010

1111
The AMQP package is tested using the standard `cargo test` command line:
1212

13-
```bash
13+
```pwsh
1414
cargo test --package azure_core_amqp --all-features
1515
```
1616

@@ -21,10 +21,11 @@ One existing AMQP broker is the "TestAMQPBroker" from the azure-amqp GitHub repo
2121
To launch the TestAMQPBroker, there are two ways of installing and running the TestAmqpBroker, Scripted and Manual.
2222

2323
### Scripted Broker Install
24+
2425
Running the broker from a script requires that you first [install Powershell](https://learn.microsoft.com/powershell/scripting/install/installing-powershell?view=powershell-7.4).
2526
From a running powershell instance, run the powershell script in the sdk/core/azure_core_amqp directory:
2627

27-
```
28+
```pwsh
2829
./sdk/core/azure_core_amqp/Test-Setup.ps1
2930
```
3031

@@ -36,35 +37,36 @@ You can then run the azure_core_amqp package tests.
3637

3738
Once you have finished running your tests, you run:
3839

39-
```
40+
```pwsh
4041
./sdk/core/azure_core_amqp/Test-Cleanup.ps1
4142
```
4243

4344
which will terminate the test broker.
4445

4546
### Manual Broker Install
47+
4648
For Manual testing, first clone the azure-amqp repository to a local directory:
4749

48-
```bash
50+
```pwsh
4951
cd <Test Working Directory>
5052
git clone https://github.com/Azure/azure-amqp
5153
```
5254

5355
Alternately, you can clone to a specific release in the azure-amqp repository:
5456

55-
```
57+
```pwsh
5658
git clone https://github.com/Azure/azure-amqp.git --branch hotfix
5759
```
5860

5961
Set an environment variable the test AMQP broker should listen on:
6062

61-
```powershell
62-
$env:TEST_BROKER_ADDRESS = 'amqp://127.0.0.1:25672'
63+
```pwsh
64+
$env:TEST_BROKER_ADDRESS = 'amqp://127.0.0.1:25672'
6365
```
6466

6567
And launch the test broker:
6668

67-
```powershell
69+
```pwsh
6870
cd azure-amqp/test/TestAmqpBroker
6971
dotnet run -- $env:TEST_BROKER_ADDRESS
7072
```

sdk/keyvault/azure_security_keyvault_keys/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ The following section provides several code snippets using the `KeyClient`, cove
100100
* [Update an existing key](#update-an-existing-key)
101101
* [Delete a key](#delete-a-key)
102102
* [List keys](#list-keys)
103+
* [Encrypt and decrypt](#encrypt-and-decrypt)
103104

104105
### Create a key
105106

0 commit comments

Comments
 (0)