Skip to content

docs: add readme content for signature-v4 #1087

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.

Sign up for GitHub

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 2 commits into from
Nov 30, 2023
Merged

docs: add readme content for signature-v4 #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff8e17f
docs: add readme content for signature-v4
kuhe Nov 30, 2023
6e6a8d9
update readme wording
kuhe Nov 30, 2023
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
5 changes: 5 additions & 0 deletions .changeset/witty-pugs-love.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@smithy/signature-v4": patch
---

add readme content for signature-v4
7 changes: 7 additions & 0 deletions packages/signature-v4/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,10 @@

[![NPM version](https://img.shields.io/npm/v/@smithy/signature-v4/latest.svg)](https://www.npmjs.com/package/@smithy/signature-v4)
[![NPM downloads](https://img.shields.io/npm/dm/@smithy/signature-v4.svg)](https://www.npmjs.com/package/@smithy/signature-v4)

This package contains an implementation of the (AWS Signature Version 4)[https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html]
authentication scheme.

It is internal to Smithy-TypeScript generated clients, and not generally intended for standalone usage outside this context.

For custom usage, inspect the interface of the SignatureV4 class.