-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Update readme.md with global template #4211
Conversation
We're working toward consistent readmes across all the language repos. This PR implements the necessary changes. Couple interesting points: * I've put a new stack overflow tag in here - azure-sdk-js. The old one (azure-node-sdk) seemed possibly confusing in light of browser support landing in a number of packages. * I've opted NOT to document minimum requirements and getting started steps like configuring typescript - these will likely be library-specific and I don't want stale information.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good - just missing the tracking image at the bottom
/cc @ramya-rao-a can you review this quick? |
README.md
Outdated
|
||
- ARM based services (`@azure/arm-<serviceName>`) | ||
- data plane SDKs like `@azure/batch`, `@azure/graph`, etc. | ||
This repository contains official JavaScript libraries for Azure services. For documentation go to [Azure SDK for JavaScript documentation](https://aka.ms/js-docs). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have had feedback from existing customers regarding the confusion between the libraries from azure-sdk-for-node repo and this one.
We can benefit from having a line here on how this repo is different from the old one and link to the migration guide.
We're working toward consistent readmes across all the language repos. This PR implements the necessary changes.
Couple interesting points: