Skip to content

docs: add notes to discourage external usage of dependencies #1241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/body-checksum-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/body-checksum-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/chunked-blob-reader-native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/chunked-blob-reader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/chunked-stream-reader-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@
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.

> An internal package

## Usage

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/client-documentation-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/config-resolver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/eventstream-handler-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/eventstream-serde-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/eventstream-serde-config-resolver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/eventstream-serde-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/eventstream-serde-universal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/hash-blob-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/hash-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/hash-stream-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,9 @@
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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/invalid-dependency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/is-array-buffer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/md5-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/property-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/querystring-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/querystring-parser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/region-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/sha256-tree-hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/smithy-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/url-parser-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/url-parser-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/util-body-length-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@
[![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

> An internal package

## Usage

You probably shouldn't, at least directly.
10 changes: 8 additions & 2 deletions packages/util-body-length-node/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# @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

> An internal package

## Usage

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/util-buffer-from/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
8 changes: 7 additions & 1 deletion packages/util-uri-escape/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# 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)

> An internal package

## Usage

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/util-user-agent-browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/util-user-agent-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.
6 changes: 6 additions & 0 deletions packages/xml-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

[![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

You probably shouldn't, at least directly.