From 2a772d467166ef619a7479b8a5be7b4ce30d26fa Mon Sep 17 00:00:00 2001 From: Allan Zheng Date: Wed, 3 Jun 2020 19:14:43 -0700 Subject: [PATCH 1/4] docs: add notes to discourage external usage of dependencies --- packages/body-checksum-browser/README.md | 4 ++++ packages/body-checksum-node/README.md | 4 ++++ packages/chunked-blob-reader-native/README.md | 4 ++++ packages/chunked-blob-reader/README.md | 4 ++++ packages/chunked-stream-reader-node/README.md | 4 ++++ packages/client-documentation-generator/README.md | 4 ++++ packages/config-resolver/README.md | 4 ++++ packages/eventstream-handler-node/README.md | 4 ++++ packages/eventstream-serde-browser/README.md | 4 ++++ packages/eventstream-serde-config-resolver/README.md | 4 ++++ packages/eventstream-serde-node/README.md | 4 ++++ packages/eventstream-serde-universal/README.md | 4 ++++ packages/hash-blob-browser/README.md | 4 ++++ packages/hash-node/README.md | 4 ++++ packages/hash-stream-node/README.md | 4 ++++ packages/invalid-dependency/README.md | 4 ++++ packages/is-array-buffer/README.md | 4 ++++ packages/md5-js/README.md | 4 ++++ packages/property-provider/README.md | 4 ++++ packages/querystring-builder/README.md | 4 ++++ packages/querystring-parser/README.md | 4 ++++ packages/region-provider/README.md | 4 ++++ packages/sha256-tree-hash/README.md | 4 ++++ packages/smithy-client/README.md | 4 ++++ packages/url-parser-browser/README.md | 4 ++++ packages/url-parser-node/README.md | 4 ++++ packages/util-body-length-browser/README.md | 4 ++++ packages/util-body-length-node/README.md | 8 ++++++-- packages/util-buffer-from/README.md | 4 ++++ packages/util-hex-encoding/README.md | 4 ++++ packages/util-uri-escape/README.md | 6 +++++- packages/util-user-agent-browser/README.md | 4 ++++ packages/util-user-agent-node/README.md | 4 ++++ packages/xml-builder/README.md | 4 ++++ 34 files changed, 139 insertions(+), 3 deletions(-) diff --git a/packages/body-checksum-browser/README.md b/packages/body-checksum-browser/README.md index 43ffca86fd4e..e059b6cc699a 100644 --- a/packages/body-checksum-browser/README.md +++ b/packages/body-checksum-browser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-browser.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/body-checksum-node/README.md b/packages/body-checksum-node/README.md index 888960d45bd7..7ec7016cbbc4 100644 --- a/packages/body-checksum-node/README.md +++ b/packages/body-checksum-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-node.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/chunked-blob-reader-native/README.md b/packages/chunked-blob-reader-native/README.md index edf405040913..f5a1883abcd0 100644 --- a/packages/chunked-blob-reader-native/README.md +++ b/packages/chunked-blob-reader-native/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader-native/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader-native.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/chunked-blob-reader/README.md b/packages/chunked-blob-reader/README.md index 632183ada838..c074b7c36afd 100644 --- a/packages/chunked-blob-reader/README.md +++ b/packages/chunked-blob-reader/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/chunked-stream-reader-node/README.md b/packages/chunked-stream-reader-node/README.md index ad5b62605e82..1fe48b3db81d 100644 --- a/packages/chunked-stream-reader-node/README.md +++ b/packages/chunked-stream-reader-node/README.md @@ -6,3 +6,7 @@ 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. This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes. + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/client-documentation-generator/README.md b/packages/client-documentation-generator/README.md index 376efd59c509..737f90b065a4 100644 --- a/packages/client-documentation-generator/README.md +++ b/packages/client-documentation-generator/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-documentation-generator/beta.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-documentation-generator.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/config-resolver/README.md b/packages/config-resolver/README.md index 7dd965bbef9a..8c332b1e6b9e 100644 --- a/packages/config-resolver/README.md +++ b/packages/config-resolver/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/config-resolver/beta.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/eventstream-handler-node/README.md b/packages/eventstream-handler-node/README.md index 526e1316b556..13e9714c33ac 100644 --- a/packages/eventstream-handler-node/README.md +++ b/packages/eventstream-handler-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-handler-node/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-handler-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-browser/README.md b/packages/eventstream-serde-browser/README.md index 63e8456b40ac..01c9d340f4f1 100644 --- a/packages/eventstream-serde-browser/README.md +++ b/packages/eventstream-serde-browser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-browser/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-browser.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-config-resolver/README.md b/packages/eventstream-serde-config-resolver/README.md index 58977f6cbcd4..204e78e4ace8 100644 --- a/packages/eventstream-serde-config-resolver/README.md +++ b/packages/eventstream-serde-config-resolver/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-node/README.md b/packages/eventstream-serde-node/README.md index df5aa2f40b73..192fc5e51976 100644 --- a/packages/eventstream-serde-node/README.md +++ b/packages/eventstream-serde-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-universal/README.md b/packages/eventstream-serde-universal/README.md index 84517ab08a37..1c62b2a15a52 100644 --- a/packages/eventstream-serde-universal/README.md +++ b/packages/eventstream-serde-universal/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-universal/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-universal.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/hash-blob-browser/README.md b/packages/hash-blob-browser/README.md index e81a1d5c14dc..ccdfade5f2f7 100644 --- a/packages/hash-blob-browser/README.md +++ b/packages/hash-blob-browser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-blob-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-blob-browser.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/hash-node/README.md b/packages/hash-node/README.md index e350b6a958f2..456ca7fb0efa 100644 --- a/packages/hash-node/README.md +++ b/packages/hash-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/hash-stream-node/README.md b/packages/hash-stream-node/README.md index 3590c2b7b11b..5f4c6f79a35b 100644 --- a/packages/hash-stream-node/README.md +++ b/packages/hash-stream-node/README.md @@ -6,3 +6,7 @@ A utility for calculating the hash of Node.JS readable streams. This package is currently only compatible with file streams, as no other stream type can be replayed. + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/invalid-dependency/README.md b/packages/invalid-dependency/README.md index 0a7eee722770..1eca1f3cccad 100644 --- a/packages/invalid-dependency/README.md +++ b/packages/invalid-dependency/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/invalid-dependency/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/invalid-dependency.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/is-array-buffer/README.md b/packages/is-array-buffer/README.md index d1bc6d4d0ea6..31ce4be79335 100644 --- a/packages/is-array-buffer/README.md +++ b/packages/is-array-buffer/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/is-array-buffer/beta.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/is-array-buffer.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/md5-js/README.md b/packages/md5-js/README.md index 31b0e4341099..0fc14391a63d 100644 --- a/packages/md5-js/README.md +++ b/packages/md5-js/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/md5-js/beta.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/md5-js.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/property-provider/README.md b/packages/property-provider/README.md index 522f3d465465..3c69bed9e6f6 100644 --- a/packages/property-provider/README.md +++ b/packages/property-provider/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/property-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/property-provider.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/querystring-builder/README.md b/packages/querystring-builder/README.md index 827eed04ed58..19e3bb1a5a89 100644 --- a/packages/querystring-builder/README.md +++ b/packages/querystring-builder/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-builder.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/querystring-parser/README.md b/packages/querystring-parser/README.md index 0c25f8559a77..96feca2fead2 100644 --- a/packages/querystring-parser/README.md +++ b/packages/querystring-parser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-parser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-parser.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/region-provider/README.md b/packages/region-provider/README.md index 3c10ed87a793..ab9ae9f66bbb 100644 --- a/packages/region-provider/README.md +++ b/packages/region-provider/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/region-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/region-provider.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/sha256-tree-hash/README.md b/packages/sha256-tree-hash/README.md index 162812ca7849..9cb7a26c7324 100644 --- a/packages/sha256-tree-hash/README.md +++ b/packages/sha256-tree-hash/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/sha256-tree-hash/beta.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/sha256-tree-hash.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/smithy-client/README.md b/packages/smithy-client/README.md index 2588e3156e4f..d725afb1355a 100644 --- a/packages/smithy-client/README.md +++ b/packages/smithy-client/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/smithy-client/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/smithy-client.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/url-parser-browser/README.md b/packages/url-parser-browser/README.md index fa4d07c1b879..4b424aad1a27 100644 --- a/packages/url-parser-browser/README.md +++ b/packages/url-parser-browser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-browser.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/url-parser-node/README.md b/packages/url-parser-node/README.md index 831e5f96522f..68eeabc75a06 100644 --- a/packages/url-parser-node/README.md +++ b/packages/url-parser-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-node.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-body-length-browser/README.md b/packages/util-body-length-browser/README.md index 1479d22ec34d..70a675558ad3 100644 --- a/packages/util-body-length-browser/README.md +++ b/packages/util-body-length-browser/README.md @@ -4,3 +4,7 @@ [![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) Determines the length of a request body in browsers + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-body-length-node/README.md b/packages/util-body-length-node/README.md index 069aa0498887..87081433eac8 100644 --- a/packages/util-body-length-node/README.md +++ b/packages/util-body-length-node/README.md @@ -1,6 +1,10 @@ # @aws-sdk/util-body-length-node -Determines the length of a request body in node.js - [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-body-length-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-node) [![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) + +Determines the length of a request body in node.js + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-buffer-from/README.md b/packages/util-buffer-from/README.md index 34bdd55684de..b764b4e4a559 100644 --- a/packages/util-buffer-from/README.md +++ b/packages/util-buffer-from/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-buffer-from/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-buffer-from.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-hex-encoding/README.md b/packages/util-hex-encoding/README.md index 4a96e0eada76..ed4c5e76c215 100644 --- a/packages/util-hex-encoding/README.md +++ b/packages/util-hex-encoding/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-hex-encoding/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-hex-encoding.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-uri-escape/README.md b/packages/util-uri-escape/README.md index 920de120b3ff..403c0fe1e7a5 100644 --- a/packages/util-uri-escape/README.md +++ b/packages/util-uri-escape/README.md @@ -1,4 +1,8 @@ -# util-uri-encode +# util-uri-escape [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-uri-escape/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-uri-escape.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-user-agent-browser/README.md b/packages/util-user-agent-browser/README.md index 22a76fe4e371..d2d66ecf8a8b 100644 --- a/packages/util-user-agent-browser/README.md +++ b/packages/util-user-agent-browser/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/util-user-agent-node/README.md b/packages/util-user-agent-node/README.md index 7cbb823cd213..19d50c02ed88 100644 --- a/packages/util-user-agent-node/README.md +++ b/packages/util-user-agent-node/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) + +## Usage + +This package is not supposed to be used directly. diff --git a/packages/xml-builder/README.md b/packages/xml-builder/README.md index 224f6e27c1f3..cc509e080c19 100644 --- a/packages/xml-builder/README.md +++ b/packages/xml-builder/README.md @@ -2,3 +2,7 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/xml-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/xml-builder.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder) + +## Usage + +This package is not supposed to be used directly. From 1b8c7eb27278e649b984a37b0b60b97250dd9bd4 Mon Sep 17 00:00:00 2001 From: Allan Zheng Date: Thu, 4 Jun 2020 15:55:53 -0700 Subject: [PATCH 2/4] docs: add internal package mentioning --- packages/body-checksum-browser/README.md | 2 ++ packages/body-checksum-node/README.md | 2 ++ packages/chunked-blob-reader-native/README.md | 2 ++ packages/chunked-blob-reader/README.md | 2 ++ packages/chunked-stream-reader-node/README.md | 2 ++ packages/client-documentation-generator/README.md | 2 ++ packages/config-resolver/README.md | 2 ++ packages/eventstream-handler-node/README.md | 2 ++ packages/eventstream-serde-browser/README.md | 2 ++ packages/eventstream-serde-config-resolver/README.md | 2 ++ packages/eventstream-serde-node/README.md | 2 ++ packages/eventstream-serde-universal/README.md | 2 ++ packages/hash-blob-browser/README.md | 2 ++ packages/hash-node/README.md | 2 ++ packages/hash-stream-node/README.md | 2 ++ packages/invalid-dependency/README.md | 2 ++ packages/is-array-buffer/README.md | 2 ++ packages/md5-js/README.md | 2 ++ packages/property-provider/README.md | 2 ++ packages/querystring-builder/README.md | 2 ++ packages/querystring-parser/README.md | 2 ++ packages/region-provider/README.md | 2 ++ packages/sha256-tree-hash/README.md | 2 ++ packages/smithy-client/README.md | 2 ++ packages/url-parser-browser/README.md | 2 ++ packages/url-parser-node/README.md | 2 ++ packages/util-body-length-browser/README.md | 2 ++ packages/util-body-length-node/README.md | 2 ++ packages/util-buffer-from/README.md | 2 ++ packages/util-hex-encoding/README.md | 2 ++ packages/util-uri-escape/README.md | 2 ++ packages/util-user-agent-browser/README.md | 2 ++ packages/util-user-agent-node/README.md | 2 ++ packages/xml-builder/README.md | 2 ++ 34 files changed, 68 insertions(+) diff --git a/packages/body-checksum-browser/README.md b/packages/body-checksum-browser/README.md index e059b6cc699a..7335f13579d6 100644 --- a/packages/body-checksum-browser/README.md +++ b/packages/body-checksum-browser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-browser.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/body-checksum-node/README.md b/packages/body-checksum-node/README.md index 7ec7016cbbc4..790b3f28aa19 100644 --- a/packages/body-checksum-node/README.md +++ b/packages/body-checksum-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-node.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/chunked-blob-reader-native/README.md b/packages/chunked-blob-reader-native/README.md index f5a1883abcd0..de4efcd3121b 100644 --- a/packages/chunked-blob-reader-native/README.md +++ b/packages/chunked-blob-reader-native/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader-native/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader-native.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/chunked-blob-reader/README.md b/packages/chunked-blob-reader/README.md index c074b7c36afd..d52dc7ad0bb8 100644 --- a/packages/chunked-blob-reader/README.md +++ b/packages/chunked-blob-reader/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/chunked-stream-reader-node/README.md b/packages/chunked-stream-reader-node/README.md index 1fe48b3db81d..fb8b081cf5aa 100644 --- a/packages/chunked-stream-reader-node/README.md +++ b/packages/chunked-stream-reader-node/README.md @@ -7,6 +7,8 @@ Exports a streamReader function that accepts a readable stream, a function to ca This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes. +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/client-documentation-generator/README.md b/packages/client-documentation-generator/README.md index 737f90b065a4..2333c4592bf9 100644 --- a/packages/client-documentation-generator/README.md +++ b/packages/client-documentation-generator/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-documentation-generator/beta.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-documentation-generator.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/config-resolver/README.md b/packages/config-resolver/README.md index 8c332b1e6b9e..4c1ba3eccf2e 100644 --- a/packages/config-resolver/README.md +++ b/packages/config-resolver/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/config-resolver/beta.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/eventstream-handler-node/README.md b/packages/eventstream-handler-node/README.md index 13e9714c33ac..89a3601f9bf7 100644 --- a/packages/eventstream-handler-node/README.md +++ b/packages/eventstream-handler-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-handler-node/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-handler-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-browser/README.md b/packages/eventstream-serde-browser/README.md index 01c9d340f4f1..c08229b6464b 100644 --- a/packages/eventstream-serde-browser/README.md +++ b/packages/eventstream-serde-browser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-browser/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-browser.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-config-resolver/README.md b/packages/eventstream-serde-config-resolver/README.md index 204e78e4ace8..262bb8d1aa39 100644 --- a/packages/eventstream-serde-config-resolver/README.md +++ b/packages/eventstream-serde-config-resolver/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-node/README.md b/packages/eventstream-serde-node/README.md index 192fc5e51976..01cf8175677b 100644 --- a/packages/eventstream-serde-node/README.md +++ b/packages/eventstream-serde-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/eventstream-serde-universal/README.md b/packages/eventstream-serde-universal/README.md index 1c62b2a15a52..2f0f11fa5953 100644 --- a/packages/eventstream-serde-universal/README.md +++ b/packages/eventstream-serde-universal/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-universal/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-universal.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/hash-blob-browser/README.md b/packages/hash-blob-browser/README.md index ccdfade5f2f7..30ced0ff5826 100644 --- a/packages/hash-blob-browser/README.md +++ b/packages/hash-blob-browser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-blob-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-blob-browser.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/hash-node/README.md b/packages/hash-node/README.md index 456ca7fb0efa..9322bebeabb9 100644 --- a/packages/hash-node/README.md +++ b/packages/hash-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/hash-stream-node/README.md b/packages/hash-stream-node/README.md index 5f4c6f79a35b..37a5f09947ba 100644 --- a/packages/hash-stream-node/README.md +++ b/packages/hash-stream-node/README.md @@ -7,6 +7,8 @@ A utility for calculating the hash of Node.JS readable streams. This package is currently only compatible with file streams, as no other stream type can be replayed. +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/invalid-dependency/README.md b/packages/invalid-dependency/README.md index 1eca1f3cccad..e973e8cf7652 100644 --- a/packages/invalid-dependency/README.md +++ b/packages/invalid-dependency/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/invalid-dependency/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/invalid-dependency.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/is-array-buffer/README.md b/packages/is-array-buffer/README.md index 31ce4be79335..3c0e921f65a2 100644 --- a/packages/is-array-buffer/README.md +++ b/packages/is-array-buffer/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/is-array-buffer/beta.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/is-array-buffer.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/md5-js/README.md b/packages/md5-js/README.md index 0fc14391a63d..f7bda7ec2235 100644 --- a/packages/md5-js/README.md +++ b/packages/md5-js/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/md5-js/beta.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/md5-js.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/property-provider/README.md b/packages/property-provider/README.md index 3c69bed9e6f6..3029d93e0d15 100644 --- a/packages/property-provider/README.md +++ b/packages/property-provider/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/property-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/property-provider.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/querystring-builder/README.md b/packages/querystring-builder/README.md index 19e3bb1a5a89..3f67ddc88460 100644 --- a/packages/querystring-builder/README.md +++ b/packages/querystring-builder/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-builder.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/querystring-parser/README.md b/packages/querystring-parser/README.md index 96feca2fead2..eb190a9fd582 100644 --- a/packages/querystring-parser/README.md +++ b/packages/querystring-parser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-parser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-parser.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/region-provider/README.md b/packages/region-provider/README.md index ab9ae9f66bbb..fedbb113a52e 100644 --- a/packages/region-provider/README.md +++ b/packages/region-provider/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/region-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/region-provider.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/sha256-tree-hash/README.md b/packages/sha256-tree-hash/README.md index 9cb7a26c7324..288eae89def8 100644 --- a/packages/sha256-tree-hash/README.md +++ b/packages/sha256-tree-hash/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/sha256-tree-hash/beta.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/sha256-tree-hash.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/smithy-client/README.md b/packages/smithy-client/README.md index d725afb1355a..8784ab5a42ff 100644 --- a/packages/smithy-client/README.md +++ b/packages/smithy-client/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/smithy-client/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/smithy-client.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/url-parser-browser/README.md b/packages/url-parser-browser/README.md index 4b424aad1a27..ab63d6b8ff95 100644 --- a/packages/url-parser-browser/README.md +++ b/packages/url-parser-browser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-browser.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/url-parser-node/README.md b/packages/url-parser-node/README.md index 68eeabc75a06..99c8ada08a1b 100644 --- a/packages/url-parser-node/README.md +++ b/packages/url-parser-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-node.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-body-length-browser/README.md b/packages/util-body-length-browser/README.md index 70a675558ad3..d50c34befbe3 100644 --- a/packages/util-body-length-browser/README.md +++ b/packages/util-body-length-browser/README.md @@ -5,6 +5,8 @@ Determines the length of a request body in browsers +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-body-length-node/README.md b/packages/util-body-length-node/README.md index 87081433eac8..065d2d9baf9b 100644 --- a/packages/util-body-length-node/README.md +++ b/packages/util-body-length-node/README.md @@ -5,6 +5,8 @@ Determines the length of a request body in node.js +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-buffer-from/README.md b/packages/util-buffer-from/README.md index b764b4e4a559..b3c65eb72eb3 100644 --- a/packages/util-buffer-from/README.md +++ b/packages/util-buffer-from/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-buffer-from/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-buffer-from.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-hex-encoding/README.md b/packages/util-hex-encoding/README.md index ed4c5e76c215..cfc001ea7675 100644 --- a/packages/util-hex-encoding/README.md +++ b/packages/util-hex-encoding/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-hex-encoding/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-hex-encoding.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-uri-escape/README.md b/packages/util-uri-escape/README.md index 403c0fe1e7a5..875c0d1c9c47 100644 --- a/packages/util-uri-escape/README.md +++ b/packages/util-uri-escape/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-uri-escape/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-uri-escape.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-user-agent-browser/README.md b/packages/util-user-agent-browser/README.md index d2d66ecf8a8b..0c9414327be9 100644 --- a/packages/util-user-agent-browser/README.md +++ b/packages/util-user-agent-browser/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/util-user-agent-node/README.md b/packages/util-user-agent-node/README.md index 19d50c02ed88..58af149ae5a5 100644 --- a/packages/util-user-agent-node/README.md +++ b/packages/util-user-agent-node/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node) +> An internal package + ## Usage This package is not supposed to be used directly. diff --git a/packages/xml-builder/README.md b/packages/xml-builder/README.md index cc509e080c19..72dd3828d847 100644 --- a/packages/xml-builder/README.md +++ b/packages/xml-builder/README.md @@ -3,6 +3,8 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/xml-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/xml-builder.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder) +> An internal package + ## Usage This package is not supposed to be used directly. From 49be93ee18bde6c781fa61aee9217d35f2d01ba1 Mon Sep 17 00:00:00 2001 From: Allan Zheng Date: Thu, 4 Jun 2020 16:01:57 -0700 Subject: [PATCH 3/4] docs: update internal packages wording --- packages/body-checksum-browser/README.md | 2 +- packages/body-checksum-node/README.md | 2 +- packages/chunked-blob-reader-native/README.md | 2 +- packages/chunked-blob-reader/README.md | 2 +- packages/chunked-stream-reader-node/README.md | 2 +- packages/client-documentation-generator/README.md | 2 +- packages/config-resolver/README.md | 2 +- packages/eventstream-handler-node/README.md | 2 +- packages/eventstream-serde-browser/README.md | 2 +- packages/eventstream-serde-config-resolver/README.md | 2 +- packages/eventstream-serde-node/README.md | 2 +- packages/eventstream-serde-universal/README.md | 2 +- packages/hash-blob-browser/README.md | 2 +- packages/hash-node/README.md | 2 +- packages/hash-stream-node/README.md | 2 +- packages/invalid-dependency/README.md | 2 +- packages/is-array-buffer/README.md | 2 +- packages/md5-js/README.md | 2 +- packages/property-provider/README.md | 2 +- packages/querystring-builder/README.md | 2 +- packages/querystring-parser/README.md | 2 +- packages/region-provider/README.md | 2 +- packages/sha256-tree-hash/README.md | 2 +- packages/smithy-client/README.md | 2 +- packages/url-parser-browser/README.md | 2 +- packages/url-parser-node/README.md | 2 +- packages/util-body-length-browser/README.md | 2 +- packages/util-body-length-node/README.md | 2 +- packages/util-buffer-from/README.md | 2 +- packages/util-hex-encoding/README.md | 2 +- packages/util-uri-escape/README.md | 2 +- packages/util-user-agent-browser/README.md | 2 +- packages/util-user-agent-node/README.md | 2 +- packages/xml-builder/README.md | 2 +- 34 files changed, 34 insertions(+), 34 deletions(-) diff --git a/packages/body-checksum-browser/README.md b/packages/body-checksum-browser/README.md index 7335f13579d6..c8324833da5a 100644 --- a/packages/body-checksum-browser/README.md +++ b/packages/body-checksum-browser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/body-checksum-node/README.md b/packages/body-checksum-node/README.md index 790b3f28aa19..cf932052476e 100644 --- a/packages/body-checksum-node/README.md +++ b/packages/body-checksum-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/chunked-blob-reader-native/README.md b/packages/chunked-blob-reader-native/README.md index de4efcd3121b..0e58b5117b88 100644 --- a/packages/chunked-blob-reader-native/README.md +++ b/packages/chunked-blob-reader-native/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/chunked-blob-reader/README.md b/packages/chunked-blob-reader/README.md index d52dc7ad0bb8..779aed3c292f 100644 --- a/packages/chunked-blob-reader/README.md +++ b/packages/chunked-blob-reader/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/chunked-stream-reader-node/README.md b/packages/chunked-stream-reader-node/README.md index fb8b081cf5aa..999cf702ddd5 100644 --- a/packages/chunked-stream-reader-node/README.md +++ b/packages/chunked-stream-reader-node/README.md @@ -11,4 +11,4 @@ This package is meant for the AWS SDK for JavaScript to enable reading a stream ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/client-documentation-generator/README.md b/packages/client-documentation-generator/README.md index 2333c4592bf9..524225c1b877 100644 --- a/packages/client-documentation-generator/README.md +++ b/packages/client-documentation-generator/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/config-resolver/README.md b/packages/config-resolver/README.md index 4c1ba3eccf2e..ee183f0032ce 100644 --- a/packages/config-resolver/README.md +++ b/packages/config-resolver/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/eventstream-handler-node/README.md b/packages/eventstream-handler-node/README.md index 89a3601f9bf7..e93f6cae54db 100644 --- a/packages/eventstream-handler-node/README.md +++ b/packages/eventstream-handler-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/eventstream-serde-browser/README.md b/packages/eventstream-serde-browser/README.md index c08229b6464b..34f80ed9c527 100644 --- a/packages/eventstream-serde-browser/README.md +++ b/packages/eventstream-serde-browser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/eventstream-serde-config-resolver/README.md b/packages/eventstream-serde-config-resolver/README.md index 262bb8d1aa39..1d0deb4c70dc 100644 --- a/packages/eventstream-serde-config-resolver/README.md +++ b/packages/eventstream-serde-config-resolver/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/eventstream-serde-node/README.md b/packages/eventstream-serde-node/README.md index 01cf8175677b..bb8fa2a12ae2 100644 --- a/packages/eventstream-serde-node/README.md +++ b/packages/eventstream-serde-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/eventstream-serde-universal/README.md b/packages/eventstream-serde-universal/README.md index 2f0f11fa5953..1db5e08a522a 100644 --- a/packages/eventstream-serde-universal/README.md +++ b/packages/eventstream-serde-universal/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/hash-blob-browser/README.md b/packages/hash-blob-browser/README.md index 30ced0ff5826..bfe7bd6919b7 100644 --- a/packages/hash-blob-browser/README.md +++ b/packages/hash-blob-browser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/hash-node/README.md b/packages/hash-node/README.md index 9322bebeabb9..76a9a176cbd3 100644 --- a/packages/hash-node/README.md +++ b/packages/hash-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/hash-stream-node/README.md b/packages/hash-stream-node/README.md index 37a5f09947ba..193a9c6c187d 100644 --- a/packages/hash-stream-node/README.md +++ b/packages/hash-stream-node/README.md @@ -11,4 +11,4 @@ replayed. ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/invalid-dependency/README.md b/packages/invalid-dependency/README.md index e973e8cf7652..1d4a839b6118 100644 --- a/packages/invalid-dependency/README.md +++ b/packages/invalid-dependency/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/is-array-buffer/README.md b/packages/is-array-buffer/README.md index 3c0e921f65a2..ec87bcaf6eb2 100644 --- a/packages/is-array-buffer/README.md +++ b/packages/is-array-buffer/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/md5-js/README.md b/packages/md5-js/README.md index f7bda7ec2235..eb6790853cac 100644 --- a/packages/md5-js/README.md +++ b/packages/md5-js/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/property-provider/README.md b/packages/property-provider/README.md index 3029d93e0d15..b867cbef0209 100644 --- a/packages/property-provider/README.md +++ b/packages/property-provider/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/querystring-builder/README.md b/packages/querystring-builder/README.md index 3f67ddc88460..b92f85701b9b 100644 --- a/packages/querystring-builder/README.md +++ b/packages/querystring-builder/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/querystring-parser/README.md b/packages/querystring-parser/README.md index eb190a9fd582..93a893025c8d 100644 --- a/packages/querystring-parser/README.md +++ b/packages/querystring-parser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/region-provider/README.md b/packages/region-provider/README.md index fedbb113a52e..868eaaa710e2 100644 --- a/packages/region-provider/README.md +++ b/packages/region-provider/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/sha256-tree-hash/README.md b/packages/sha256-tree-hash/README.md index 288eae89def8..b6bae2bb0734 100644 --- a/packages/sha256-tree-hash/README.md +++ b/packages/sha256-tree-hash/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/smithy-client/README.md b/packages/smithy-client/README.md index 8784ab5a42ff..0ddc13a0821e 100644 --- a/packages/smithy-client/README.md +++ b/packages/smithy-client/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/url-parser-browser/README.md b/packages/url-parser-browser/README.md index ab63d6b8ff95..cc5a06b0b257 100644 --- a/packages/url-parser-browser/README.md +++ b/packages/url-parser-browser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/url-parser-node/README.md b/packages/url-parser-node/README.md index 99c8ada08a1b..7720813730af 100644 --- a/packages/url-parser-node/README.md +++ b/packages/url-parser-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-body-length-browser/README.md b/packages/util-body-length-browser/README.md index d50c34befbe3..f0ad4a6140c9 100644 --- a/packages/util-body-length-browser/README.md +++ b/packages/util-body-length-browser/README.md @@ -9,4 +9,4 @@ Determines the length of a request body in browsers ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-body-length-node/README.md b/packages/util-body-length-node/README.md index 065d2d9baf9b..b51147b1d53b 100644 --- a/packages/util-body-length-node/README.md +++ b/packages/util-body-length-node/README.md @@ -9,4 +9,4 @@ Determines the length of a request body in node.js ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-buffer-from/README.md b/packages/util-buffer-from/README.md index b3c65eb72eb3..aa6590851522 100644 --- a/packages/util-buffer-from/README.md +++ b/packages/util-buffer-from/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-hex-encoding/README.md b/packages/util-hex-encoding/README.md index cfc001ea7675..59122a4bb3a4 100644 --- a/packages/util-hex-encoding/README.md +++ b/packages/util-hex-encoding/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-uri-escape/README.md b/packages/util-uri-escape/README.md index 875c0d1c9c47..bec67c2e869f 100644 --- a/packages/util-uri-escape/README.md +++ b/packages/util-uri-escape/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-user-agent-browser/README.md b/packages/util-user-agent-browser/README.md index 0c9414327be9..92be64b578bf 100644 --- a/packages/util-user-agent-browser/README.md +++ b/packages/util-user-agent-browser/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/util-user-agent-node/README.md b/packages/util-user-agent-node/README.md index 58af149ae5a5..e850eda11993 100644 --- a/packages/util-user-agent-node/README.md +++ b/packages/util-user-agent-node/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. diff --git a/packages/xml-builder/README.md b/packages/xml-builder/README.md index 72dd3828d847..e4030de0d314 100644 --- a/packages/xml-builder/README.md +++ b/packages/xml-builder/README.md @@ -7,4 +7,4 @@ ## Usage -This package is not supposed to be used directly. +You probably shouldn't, at least directly. From 54606ebe0c5d2716ffa8e7465aeb3498b0d10de2 Mon Sep 17 00:00:00 2001 From: Allan Zheng Date: Fri, 5 Jun 2020 15:46:23 -0700 Subject: [PATCH 4/4] docs: remove util-hex-encoding from internals --- packages/util-hex-encoding/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/packages/util-hex-encoding/README.md b/packages/util-hex-encoding/README.md index 59122a4bb3a4..4a96e0eada76 100644 --- a/packages/util-hex-encoding/README.md +++ b/packages/util-hex-encoding/README.md @@ -2,9 +2,3 @@ [![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-hex-encoding/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-hex-encoding.svg)](https://www.npmjs.com/package/@aws-sdk/util-hex-encoding) - -> An internal package - -## Usage - -You probably shouldn't, at least directly.