From 358802dd1bd6cf95cabbefbdece9973e38909390 Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Tue, 15 Dec 2020 16:15:56 -0800 Subject: [PATCH] Clarify how one would use this package --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6a673f..24e1535 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ # ms-rest-azure-js [![Build Status](https://dev.azure.com/azure-public/azsdk/_apis/build/status/public.Azure.ms-rest-azure-js%20-%20CI?branchName=master)](https://dev.azure.com/azure-public/azsdk/_build/latest?definitionId=31&branchName=master) -Azure Runtime for isomorphic javascript libraries (that work in the browser and node.js environemnt) generated via [Autorest](https://github.com/Azure/Autorest). +Azure Runtime with support for long running operations used by packages generated via the code generator [@microsoft.azure/autorest.typescript](https://www.npmjs.com/package/@microsoft.azure/autorest.typescript). + +Use this package if you are writing a library for one of the Azure services whose API requires support for long running operations. +To write a library for one of the Azure services whose API does not need support for long running operations, [@azure/ms-rest-js](https://www.npmjs.com/package/@azure/ms-rest-js) should suffice. + +If you are not a library writer for any of the Azure services, you should not need to use this package except for one scenario which is authenticating to any of the Cognitive Services using the below packages. This is when you would use the [CognitiveServicesCredentials](https://github.com/Azure/ms-rest-azure-js/blob/71b0b77ab7c3b9ecb731baab61d207eaa8bb2e97/lib/credentials/cognitiveServicesCredentials.ts#L12) exported from this package. + +- [@azure/cognitiveservices-computervision](https://www.npmjs.com/package/@azure/cognitiveservices-computervision) +- [@azure/cognitiveservices-luis-authoring](https://www.npmjs.com/package/@azure/cognitiveservices-luis-authoring) +- [@azure/cognitiveservices-luis-runtime](https://www.npmjs.com/package/@azure/cognitiveservices-luis-runtime) +- [@azure/cognitiveservices-qnamaker](https://www.npmjs.com/package/@azure/cognitiveservices-qnamaker) +- [@azure/cognitiveservices-qnamaker-runtime](https://www.npmjs.com/package/@azure/cognitiveservices-qnamaker-runtime) +- [@azure/cognitiveservices-imagesearch](https://www.npmjs.com/package/@azure/cognitiveservices-imagesearch) +- [@azure/cognitiveservices-contentmoderator](https://www.npmjs.com/package/@azure/cognitiveservices-contentmoderator) +- [@azure/cognitiveservices-anomalydetector](https://www.npmjs.com/package/@azure/cognitiveservices-anomalydetector) +- [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face) +- [@azure/cognitiveservices-websearch](https://www.npmjs.com/package/@azure/cognitiveservices-websearch) +- [@azure/cognitiveservices-spellcheck](https://www.npmjs.com/package/@azure/cognitiveservices-spellcheck) +- [@azure/cognitiveservices-customvision-prediction](https://www.npmjs.com/package/@azure/cognitiveservices-customvision-prediction) +- [@azure/cognitiveservices-customvision-training](https://www.npmjs.com/package/@azure/cognitiveservices-customvision-training) +- [@azure/cognitiveservices-customsearch](https://www.npmjs.com/package/@azure/cognitiveservices-customsearch) +- [@azure/cognitiveservices-localsearch](https://www.npmjs.com/package/@azure/cognitiveservices-localsearch) +- [@azure/cognitiveservices-personalizer](https://www.npmjs.com/package/@azure/cognitiveservices-personalizer) +- [@azure/cognitiveservices-newssearch](https://www.npmjs.com/package/@azure/cognitiveservices-newssearch) +- [@azure/cognitiveservices-visualsearch](https://www.npmjs.com/package/@azure/cognitiveservices-visualsearch) +- [@azure/cognitiveservices-videosearch](https://www.npmjs.com/package/@azure/cognitiveservices-videosearch) +- [@azure/cognitiveservices-formrecognizer](https://www.npmjs.com/package/@azure/cognitiveservices-formrecognizer) +- [@azure/cognitiveservices-autosuggest](https://www.npmjs.com/package/@azure/cognitiveservices-autosuggest) +- [@azure/cognitiveservices-entitysearch](https://www.npmjs.com/package/@azure/cognitiveservices-entitysearch) +- [@azure/cognitiveservices-customimagesearch](https://www.npmjs.com/package/@azure/cognitiveservices-customimagesearch) +- [@azure/cognitiveservices-translatortext](https://www.npmjs.com/package/@azure/cognitiveservices-translatortext) +- [@azure/cognitiveservices-textanalytics](https://www.npmjs.com/package/@azure/cognitiveservices-textanalytics) ## Requirements - node.js version > 6.x