npm install instructions missing

[surrealroad]

Describe the issue

The instructions to install using npm on the readme are missing.

The big button on https://aws.amazon.com/sdk-for-javascript/ links to the readme.
The readme itself says:

All clients have been published to NPM and can be installed as described above.

Except it doesn't

Links

https://github.com/aws/aws-sdk-js-v3#getting-started

[ukumar0]

Thanks for raising this! I also noticed the confusion — the README says "installed as described above," but there's currently no npm install example in that section.

Would it make sense to add a simple example like this under "Getting Started"?

npm install @aws-sdk/client-s3

[surrealroad]

ok good, I thought maybe it was just me missing something obvious!
Maybe I will submit a PR in this case.

[aBurmeseDev]

Hi @surrealroad - thanks for reaching out and appreciate your feedback.

I understand that you're looking for instructions to NPM install SDK client in our README and I also noticed it had yarn add in there on list item 2 but missing npm install. Let me chat with the team on the best way to add it.

Meanwhile, I suggest new SDK users to check out our Developer Guide, which has all the "need to know" information to get it started. For example, this page shows all the prerequisites as well as client installation with NPM.

Hope it helps!

[surrealroad]

Thanks for the reply.
The big issue though is that I got to the readme via this:

Which is of course confusing as there's no mention of npm.

[aBurmeseDev]

Hi @surrealroad, we've updated that Install from NPM button linked to our developer guide Get started with Node.js page.

Hope that helps other users and thanks again for your feedback here!