Skip to content

Commit 8adc10c

Browse files
trivikrtrivikr
authored
feat: add npm badges for individual packages (#251)
* feat: added README.md files in packages which don't have them * feat: add npm version and downloads badge * chore: moved npm badges below package title * chore: update package-generator scripts to add npm badges * chore: prefix @aws-sdk/ in README.ms of packages where it's absent * chore: remove npm badges from private packages
1 parent 7eca377 commit 8adc10c

File tree

121 files changed

+436
-55
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+436
-55
lines changed

Diff for: ‎packages/abort-controller/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# @aws-sdk/abort-controller
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/abort-controller.svg)](https://www.npmjs.com/package/@aws-sdk/abort-controller)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/abort-controller.svg)](https://www.npmjs.com/package/@aws-sdk/abort-controller)

Diff for: ‎packages/add-glacier-checksum-headers-browser/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# add-glacier-checksum-headers-browser
1+
# @aws-sdk/add-glacier-checksum-headers-browser
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/add-glacier-checksum-headers-browser.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/add-glacier-checksum-headers-browser.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-browser)

Diff for: ‎packages/add-glacier-checksum-headers-node/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# add-glacier-checksum-headers-node
1+
# @aws-sdk/add-glacier-checksum-headers-node
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/add-glacier-checksum-headers-node.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/add-glacier-checksum-headers-node.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-node)

Diff for: ‎packages/add-glacier-checksum-headers-universal/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# add-glacier-checksum-headers-universal
1+
# @aws-sdk/add-glacier-checksum-headers-universal
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/add-glacier-checksum-headers-universal.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-universal)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/add-glacier-checksum-headers-universal.svg)](https://www.npmjs.com/package/@aws-sdk/add-glacier-checksum-headers-universal)

Diff for: ‎packages/apply-body-checksum-middleware/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# apply-body-checksum-middleware
1+
# @aws-sdk/apply-body-checksum-middleware
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/apply-body-checksum-middleware.svg)](https://www.npmjs.com/package/@aws-sdk/apply-body-checksum-middleware)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/apply-body-checksum-middleware.svg)](https://www.npmjs.com/package/@aws-sdk/apply-body-checksum-middleware)
25

36
This package provides AWS SDK for JavaScript middleware that applies a checksum
47
of the request body as a header.

Diff for: ‎packages/bucket-endpoint-middleware/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# bucket-endpoint-middleware
1+
# @aws-sdk/bucket-endpoint-middleware
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/bucket-endpoint-middleware.svg)](https://www.npmjs.com/package/@aws-sdk/bucket-endpoint-middleware)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/bucket-endpoint-middleware.svg)](https://www.npmjs.com/package/@aws-sdk/bucket-endpoint-middleware)

Diff for: ‎packages/build-types/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# build-types
1+
# @aws-sdk/build-types

Diff for: ‎packages/chunked-blob-reader/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# chunked-blob-reader
1+
# @aws-sdk/chunked-blob-reader
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader)

Diff for: ‎packages/chunked-stream-reader-node/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# chunked-stream-reader-node
1+
# @aws-sdk/chunked-stream-reader-node
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-stream-reader-node.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-stream-reader-node.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
25

36
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer interally before calling the supplied function.
47

Diff for: ‎packages/client-codecommit-node/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-codecommit-node
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-codecommit-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-codecommit-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-codecommit-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-codecommit-node)
5+
36
## Description
47

58
<fullname>AWS CodeCommit</fullname> <p>This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.</p> <p>You can use the AWS CodeCommit API to work with the following objects:</p> <p>Repositories, by calling the following:</p> <ul> <li> <p> <a>BatchGetRepositories</a>, which returns information about one or more repositories associated with your AWS account.</p> </li> <li> <p> <a>CreateRepository</a>, which creates an AWS CodeCommit repository.</p> </li> <li> <p> <a>DeleteRepository</a>, which deletes an AWS CodeCommit repository.</p> </li> <li> <p> <a>GetRepository</a>, which returns information about a specified repository.</p> </li> <li> <p> <a>ListRepositories</a>, which lists all AWS CodeCommit repositories associated with your AWS account.</p> </li> <li> <p> <a>UpdateRepositoryDescription</a>, which sets or updates the description of the repository.</p> </li> <li> <p> <a>UpdateRepositoryName</a>, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.</p> </li> </ul> <p>Branches, by calling the following:</p> <ul> <li> <p> <a>CreateBranch</a>, which creates a new branch in a specified repository.</p> </li> <li> <p> <a>DeleteBranch</a>, which deletes the specified branch in a repository unless it is the default branch.</p> </li> <li> <p> <a>GetBranch</a>, which returns information about a specified branch.</p> </li> <li> <p> <a>ListBranches</a>, which lists all branches for a specified repository.</p> </li> <li> <p> <a>UpdateDefaultBranch</a>, which changes the default branch for a repository.</p> </li> </ul> <p>Files, by calling the following:</p> <ul> <li> <p> <a>DeleteFile</a>, which deletes the content of a specified file from a specified branch.</p> </li> <li> <p> <a>GetFile</a>, which returns the base-64 encoded content of a specified file.</p> </li> <li> <p> <a>GetFolder</a>, which returns the contents of a specified folder or directory.</p> </li> <li> <p> <a>PutFile</a>, which adds or modifies a file in a specified repository and branch.</p> </li> </ul> <p>Information about committed code in a repository, by calling the following:</p> <ul> <li> <p> <a>GetBlob</a>, which returns the base-64 encoded content of an individual Git blob object within a repository.</p> </li> <li> <p> <a>GetCommit</a>, which returns information about a commit, including commit messages and author and committer information.</p> </li> <li> <p> <a>GetDifferences</a>, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference).</p> </li> </ul> <p>Pull requests, by calling the following:</p> <ul> <li> <p> <a>CreatePullRequest</a>, which creates a pull request in a specified repository.</p> </li> <li> <p> <a>DescribePullRequestEvents</a>, which returns information about one or more pull request events.</p> </li> <li> <p> <a>GetCommentsForPullRequest</a>, which returns information about comments on a specified pull request.</p> </li> <li> <p> <a>GetMergeConflicts</a>, which returns information about merge conflicts between the source and destination branch in a pull request.</p> </li> <li> <p> <a>GetPullRequest</a>, which returns information about a specified pull request.</p> </li> <li> <p> <a>ListPullRequests</a>, which lists all pull requests for a repository.</p> </li> <li> <p> <a>MergePullRequestByFastForward</a>, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.</p> </li> <li> <p> <a>PostCommentForPullRequest</a>, which posts a comment to a pull request at the specified line, file, or request.</p> </li> <li> <p> <a>UpdatePullRequestDescription</a>, which updates the description of a pull request.</p> </li> <li> <p> <a>UpdatePullRequestStatus</a>, which updates the status of a pull request.</p> </li> <li> <p> <a>UpdatePullRequestTitle</a>, which updates the title of a pull request.</p> </li> </ul> <p>Information about comments in a repository, by calling the following:</p> <ul> <li> <p> <a>DeleteCommentContent</a>, which deletes the content of a comment on a commit in a repository.</p> </li> <li> <p> <a>GetComment</a>, which returns information about a comment on a commit.</p> </li> <li> <p> <a>GetCommentsForComparedCommit</a>, which returns information about comments on the comparison between two commit specifiers in a repository.</p> </li> <li> <p> <a>PostCommentForComparedCommit</a>, which creates a comment on the comparison between two commit specifiers in a repository.</p> </li> <li> <p> <a>PostCommentReply</a>, which creates a reply to a comment.</p> </li> <li> <p> <a>UpdateComment</a>, which updates the content of a comment on a commit in a repository.</p> </li> </ul> <p>Triggers, by calling the following:</p> <ul> <li> <p> <a>GetRepositoryTriggers</a>, which returns information about triggers configured for a repository.</p> </li> <li> <p> <a>PutRepositoryTriggers</a>, which replaces all triggers for a repository and can be used to create or delete triggers.</p> </li> <li> <p> <a>TestRepositoryTriggers</a>, which tests the functionality of a repository trigger by sending data to the trigger target.</p> </li> </ul> <p>For information about how to use AWS CodeCommit, see the <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit User Guide</a>.</p>

Diff for: ‎packages/client-cognito-identity-browser/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-cognito-identity-browser
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-cognito-identity-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-cognito-identity-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-cognito-identity-browser)
5+
36
## Description
47

58
<fullname>Amazon Cognito</fullname> <p>Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user.</p> <p>Next, make an unsigned call to <a>GetCredentialsForIdentity</a>. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. Assuming your identity pool has been configured via the <a>SetIdentityPoolRoles</a> operation, <code>GetCredentialsForIdentity</code> will return AWS credentials for your use. If your pool has not been configured with <code>SetIdentityPoolRoles</code>, or if you want to follow legacy flow, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials.</p> <p>If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/index.html">AWS Mobile SDK Developer Guide</a>.</p>

Diff for: ‎packages/client-documentation-generator/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# client-documentation-generator
1+
# @aws-sdk/client-documentation-generator
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-documentation-generator.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-documentation-generator.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator)

Diff for: ‎packages/client-dynamodb-browser/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-dynamodb-browser
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-dynamodb-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-dynamodb-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-browser)
5+
36
## Description
47

58
<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.</p> <p>With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.</p> <p>DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability. </p>

Diff for: ‎packages/client-dynamodb-node/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-dynamodb-node
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-dynamodb-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-dynamodb-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-dynamodb-node)
5+
36
## Description
47

58
<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.</p> <p>With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.</p> <p>DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability. </p>

Diff for: ‎packages/client-glacier-node/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-glacier-node
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-glacier-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-glacier-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-glacier-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-glacier-node)
5+
36
## Description
47

58
<p>Amazon Glacier is a storage solution for "cold data."</p> <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</p> <p>Amazon Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service (Amazon S3)</a>.</p> <p>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.</p> <p>If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>:</p> <ul> <li> <p> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</p> </li> <li> <p> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</p> </li> </ul>

Diff for: ‎packages/client-kinesis-browser/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# @aws-sdk/client-kinesis-browser
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-kinesis-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-kinesis-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-kinesis-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-kinesis-browser)
5+
36
## Description
47

58
<fullname>Amazon Kinesis Data Streams Service API Reference</fullname> <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.</p>

0 commit comments

Comments
 (0)