Skip to content

Commit c47cece

Browse files
trivikrsrchase
trivikr
authored and
srchase
committed
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 7b30309 commit c47cece

File tree

25 files changed

+95
-11
lines changed

25 files changed

+95
-11
lines changed

‎packages/abort-controller/README.md

Lines changed: 4 additions & 0 deletions
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)

‎packages/chunked-blob-reader/README.md

Lines changed: 4 additions & 1 deletion
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)

‎packages/config-resolver/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# config-resolver
1+
# @aws-sdk/config-resolver
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver)

‎packages/credential-provider-imds/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# AWS Credential Provider for Node.JS - Instance and Container Metadata
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-imds.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-imds)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-imds.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-imds)
5+
36
This module provides two `CredentialProvider` factory functions,
47
`fromContainerMetadata` and `fromInstanceMetadata`, that will create
58
`CredentialProvider` functions that read from the ECS container metadata service

‎packages/fetch-http-handler/README.md

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

‎packages/hash-blob-browser/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
# sha256-blob-browser
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-blob-browser.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-blob-browser.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser)

‎packages/hash-node/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
# md5-node
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node)

‎packages/hash-stream-node/README.md

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

36
A utility for calculating the hash of Node.JS readable streams. This package is
47
currently only compatible with file streams, as no other stream type can be

‎packages/is-array-buffer/README.md

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

‎packages/md5-js/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# md5-js
1+
# @aws-sdk/md5-js
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/md5-js.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/md5-js.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js)

‎packages/middleware-content-length/README.md

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

‎packages/middleware-stack/README.md

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

‎packages/node-http-handler/README.md

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

‎packages/property-provider/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# property-provider
1+
# @aws-sdk/property-provider
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/property-provider.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/property-provider.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider)

‎packages/querystring-builder/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# querystring-builder
1+
# @aws-sdk/querystring-builder
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-builder.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-builder.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder)

‎packages/querystring-parser/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# querystring-parser
1+
# @aws-sdk/querystring-parser
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-parser.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-parser.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser)

‎packages/service-error-classification/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
# service-error-classification
1+
# @aws-sdk/service-error-classification
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/service-error-classification.svg)](https://www.npmjs.com/package/@aws-sdk/service-error-classification)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/service-error-classification.svg)](https://www.npmjs.com/package/@aws-sdk/service-error-classification)

‎packages/shared-ini-file-loader/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# AWS Shared Configuration File Loader
22

3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/shared-ini-file-loader.svg)](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/shared-ini-file-loader.svg)](https://www.npmjs.com/package/@aws-sdk/shared-ini-file-loader)
5+
36
This module provides a function that reads from AWS SDK configuration files and
47
returns a promise that will resolve with a hash of the parsed contents of the
58
AWS credentials file and of the AWS config file. Given the [sample

‎packages/signature-v4/README.md

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

‎packages/types/README.md

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

‎packages/util-body-length-browser/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# util-body-length-browser
1+
# @aws-sdk/util-body-length-browser
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-body-length-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-browser)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-body-length-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-browser)
25

36
Determines the length of a request body in browsers

‎packages/util-body-length-node/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
# util-body-length-node
1+
# @aws-sdk/util-body-length-node
22

33
Determines the length of a request body in node.js
4+
5+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-body-length-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-node)
6+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-body-length-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-node)

‎packages/util-buffer-from/README.md

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

‎packages/util-hex-encoding/README.md

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

‎packages/util-uri-escape/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
# util-uri-encode
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-uri-escape.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-uri-escape.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape)

0 commit comments

Comments
 (0)