Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amarzavery authored Nov 9, 2018
1 parent 12ceccf commit 2ff8ddb
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

[![Build Status](https://dev.azure.com/azure-public/adx/_apis/build/status/public.Azure.azure-sdk-for-js)](https://dev.azure.com/azure-public/adx/_build/latest?definitionId=2)

This project provides a Javascript package that makes it easy to consume and manage
This project provides an isomorphic Javascript package with TypeScript definitions that makes it easy to consume and manage
Microsoft Azure Services.
It supports SDKs for:
- ARM services (packages with the naming convention of `azure-arm-<servicename>`)
- data plane of some Azure services (packages with the naming convention of `azure-<servicename>`).
- ARM services (control plane) (packages with the naming convention of `@azure/arm-<servicename>`)
- data plane of some Azure services (packages with the naming convention of `@azure/<servicename>`).

## Documentation

Documentation of the supported SDKs can be found here:
- https://docs.microsoft.com/en-us/javascript/azure - This website primarily provides SDK documentation for
- ARM based services (`azure-arm-<serviceName>`)
- data plane SDKs like `azure-batch`, `azure-graph`, etc.
- ARM based services (`@azure/arm-<serviceName>`)
- data plane SDKs like `@azure/batch`, `@azure/graph`, etc.

## Authentication
- For Node.js-based authentication, look at [ms-rest-nodeauth](https://npmjs.com/package/ms-rest-nodeauth).
Expand All @@ -28,9 +28,8 @@ Documentation of the supported SDKs can be found here:

## License

This project is licensed under MIT and Apache-2.0.
- "MIT" license is usually used for the client libraries generated using [Autorest](https://github.com/Azure/Autorest) that are targeting ARM (V2 version of Azure REST API). The license can be found in "LICENSE.MIT.txt" file in this repository.
- "Apache-2.0" license is usually used for the client libraries generated using an internal code generator that are targeting ASM (V1 version of Azure REST API). The license can be found in "LICENSE.Apache.txt" file in this repository.
This project is licensed under MIT.
- "MIT" license is usually used for the client libraries generated using [Autorest.TypeScript](https://github.com/azure/autorest.typescript) that are targeting ARM (V2 version of Azure REST API). The license can be found in "LICENSE.MIT.txt" file in this repository.

## Contribute

Expand Down

0 comments on commit 2ff8ddb

Please sign in to comment.