Skip to content

Commit 3ba4bd9

Browse files
authored
docs: add readme content for signature-v4 (#1087)
* docs: add readme content for signature-v4 * update readme wording
1 parent 07ff207 commit 3ba4bd9

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.changeset/witty-pugs-love.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@smithy/signature-v4": patch
3+
---
4+
5+
add readme content for signature-v4

packages/signature-v4/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,10 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@smithy/signature-v4/latest.svg)](https://www.npmjs.com/package/@smithy/signature-v4)
44
[![NPM downloads](https://img.shields.io/npm/dm/@smithy/signature-v4.svg)](https://www.npmjs.com/package/@smithy/signature-v4)
5+
6+
This package contains an implementation of the (AWS Signature Version 4)[https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html]
7+
authentication scheme.
8+
9+
It is internal to Smithy-TypeScript generated clients, and not generally intended for standalone usage outside this context.
10+
11+
For custom usage, inspect the interface of the SignatureV4 class.

0 commit comments

Comments
 (0)