Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
siyuniu-ms committed Feb 24, 2023
1 parent 0f8f851 commit bc0e7df
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion AISKULight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
Application Insights - Web Basic SDK

Application Insights AI SKU Light is a package that combines minimum required packages for Web scenarios.
Refer to [ApplicationInsights-JS](../README.MD) for more details on getting started.
Refer to [ApplicationInsights-JS](../README.md) for more details on getting started.

## Contributing

Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
[![minified size size](https://img.badgesize.io/https://js.monitor.azure.com/scripts/b/ai.2.min.js.svg?label=minified%20size)](https://img.badgesize.io/https://js.monitor.azure.com/scripts/b/ai.2.min.js.svg?label=minified%20size)
[![gzip size](https://img.badgesize.io/https://js.monitor.azure.com/scripts/b/ai.2.min.js.svg?compression=gzip&softmax=30000&max=35000)](https://img.badgesize.io/https://js.monitor.azure.com/scripts/b/ai.2.min.js.svg?compression=gzip&softmax=30000&max=35000)

> ***Note:*** The documentation for `applicationinsights-js@1.0.20` has moved [here](./legacy/README.md). If you are looking to upgrade to the new version of the SDK, please see the [Upgrade Guide](#upgrading-from-the-old-version-of-application-insights). For Node.js instrumentation reference this [repository](https://github.com/microsoft/ApplicationInsights-node.js).
> ***Note:*** The documentation for `applicationinsights-js@1.0.20` has moved [here](./legacy/README.md). If you are looking to upgrade to the new version of the SDK, please see the [Upgrade Guide](#upgrading-from-the-old-version-of-application-insights).
## Beta (v3.x) Release Breaking changes

Expand All @@ -36,6 +36,13 @@ Some of the major changes include

See the [beta](https://github.com/Microsoft/ApplicationInsights-JS/tree/beta) for the current documented set of breaking changes, all feedback on excessive breaks are welcome current release target is early (1st quarter) 2023.


## Before Getting Started

This repo does not intended for non-browser enverionments, for example, the Node.js applications.

For instrumenting a Node.js app, please refer this [repository](https://github.com/microsoft/ApplicationInsights-node.js).

## Getting Started

1. Create an Application Insights resource in Azure by following [these instructions](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-javascript?toc=/azure/azure-monitor/toc.json).
Expand Down

0 comments on commit bc0e7df

Please sign in to comment.