Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General polish to core-http and core-arm READMEs #4651

Merged
merged 1 commit into from
Aug 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .docsettings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ known_content_issues:
- ["sdk/eventgrid/eventgrid/README.md", "#1583"]
- ["sdk/core/abort-controller/README.md", "#1583"]
- ["sdk/core/core-auth/README.md", "#1583"]
- ["sdk/core/core-arm/README.md", "#1583"]
- ["sdk/cosmosdb/cosmos/README.md", "#1583"]
- ["sdk/cosmosdb/cosmos/src/test/readme.md", "#1583"]
- ["sdk/cosmosdb/cosmos/samples/readme.md", "#1583"]
Expand Down
28 changes: 21 additions & 7 deletions sdk/core/core-arm/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
# 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 Core ARM client library for JS

Azure Runtime for isomorphic javascript libraries (that work in the browser and node.js environemnt) generated via [Autorest](https://github.com/Azure/Autorest).
This is an Azure-specific layer for the core HTTP pipeline of Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript).

## Requirements
## Getting started

- node.js version > 6.x
### Requirements

- Node.js version > 6.x
- npm install -g typescript

## Installation
### Installation

- After cloning the repo, execute `npm install`

## Execution
## Key concepts

This library provides a `ServiceClient` subclass called `AzureServiceClient` which adds some Azure-specific behavior such as the management of long-running operations. For more information on the design of the underlying library `@azure/core-http`, consult the [architecture overview](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-http/docs/architectureOverview.md).

## Examples

Examples can be found in the `samples` folder.

### node.js
## Next steps

### Node.js

- Set the subscriptionId and token
- Run `node samples/node-sample.js`
Expand All @@ -23,6 +33,10 @@ Azure Runtime for isomorphic javascript libraries (that work in the browser and
- Set the subscriptionId and token and then run
- Open index.html file in the browser. It should show the response from GET request on the storage account. From Chrome type Ctrl + Shift + I and you can see the logs in console.

## Troubleshooting

If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new).

# Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down
6 changes: 3 additions & 3 deletions sdk/core/core-http/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Azure Core HTTP client library for JS

This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest).
This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript).

## Getting started

### Requirements

- node.js version > 6.x
- Node.js version > 6.x
- npm install -g typescript

### Installation
Expand All @@ -23,7 +23,7 @@ Examples can be found in the `samples` folder.

## Next steps

### node.js
### Node.js

- Set the subscriptionId and token
- Run `node samples/node-sample.js`
Expand Down