Merge pull request #131 from joheredi/ramya-rao-a-patch-1
Clarify how one would use this package
This commit is contained in:
Jose Manuel Heredia Hidalgo
GitHub
Коммит
adbde2a378
|
|
@ -1,3 +1,6 @@
|
|||
trigger:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
- job: Check_Everything
|
||||
pool:
|
||||
|
|
|
|||
33
README.md
33
README.md
|
|
@ -1,5 +1,36 @@
|
|||
# ms-rest-azure-js [](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
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
"email": "azsdkteam@microsoft.com",
|
||||
"url": "https://github.com/Azure/ms-rest-azure-js"
|
||||
},
|
||||
"version": "2.0.1",
|
||||
"version": "2.0.2",
|
||||
"description": "Isomorphic Azure client runtime for Typescript/node.js/browser javascript client libraries generated using AutoRest",
|
||||
"tags": [
|
||||
"isomorphic",
|
||||
|
|
@ -111,4 +111,4 @@
|
|||
"check:everything": "ts-node ./.scripts/checkEverything.ts"
|
||||
},
|
||||
"sideEffects": false
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче