From cdcdac5c58f25dcd27f953ce5dbd7698f8066552 Mon Sep 17 00:00:00 2001 From: Anton Kolesnyk <41349689+antkmsft@users.noreply.github.com> Date: Thu, 3 Jun 2021 17:59:16 +0000 Subject: [PATCH] Docs: link to root Getting Started section from Key Vault Keys' readme (#2387) Co-authored-by: Anton Kolesnyk --- .../azure-security-keyvault-keys/README.md | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/sdk/keyvault/azure-security-keyvault-keys/README.md b/sdk/keyvault/azure-security-keyvault-keys/README.md index 9e90cd80c..d95b525c1 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/README.md +++ b/sdk/keyvault/azure-security-keyvault-keys/README.md @@ -13,16 +13,21 @@ The Azure Key Vault keys library client supports RSA keys and Elliptic Curve (EC ## Getting started -### Install the package +### Include the package -Install the Azure Key Vault keys client library for C++ with [vcpkg](https://github.com/microsoft/vcpkg): +The easiest way to acquire the C++ SDK is leveraging vcpkg package manager. See the corresponding [Azure SDK for C++ readme section][azsdk_vcpkg_install]. -```PowerShell -# Windows -vcpkg.exe install azure-security-keyvault-keys-cpp +To install Azure Security Key Vault Keys package via vcpkg: -# Linux -./vcpkg install azure-security-keyvault-keys-cpp +```cmd +> vcpkg install azure-security-keyvault-keys-cpp +``` + +Then, use in your CMake file: + +```CMake +find_package(azure-security-keyvault-keys-cpp CONFIG REQUIRED) +target_link_libraries( PRIVATE Azure::azure-security-keyvault-keys) ``` ### Prerequisites @@ -437,7 +442,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con For more information see the [Code of Conduct FAQ][coc_faq] or contact opencode@microsoft.com with any additional questions or comments. - +[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk [api_reference]: https://docs.microsoft.com/dotnet/api/azure.security.keyvault.keys [azure_cli]: https://docs.microsoft.com/cli/azure [azure_identity]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/identity/azure-identity