Skip to content

chore: update README etc#185

Merged
kessplas merged 4 commits into
stagingfrom
kessplas/readme
May 15, 2026
Merged

chore: update README etc#185
kessplas merged 4 commits into
stagingfrom
kessplas/readme

Conversation

@kessplas

@kessplas kessplas commented May 14, 2026

Copy link
Copy Markdown
Contributor

Issue #, if available: n/a

Description of changes: Make the README more useful and touch up a few other details

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@kessplas kessplas marked this pull request as ready for review May 14, 2026 23:25
@kessplas kessplas changed the title chore: update README chore: update README etc May 14, 2026
Comment thread README.md
This library provides an S3 client that supports client-side encryption.
This library provides an S3 client that supports client-side encryption. For more information and detailed instructions for how to use this library, refer to the [Amazon S3 Encryption Client Developer Guide](https://docs.aws.amazon.com/amazon-s3-encryption-client/latest/developerguide/python.html).

## Development

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably worth having some more customer facing stuff above this section (getting started/prerequisites (separate from the dev prerequisites since you don't need uv to use this)/FAQ)

@lucasmcdonald3 lucasmcdonald3 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment on README but not blocking

@kessplas kessplas merged commit d158772 into staging May 15, 2026
40 of 41 checks passed
@kessplas kessplas deleted the kessplas/readme branch May 15, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants