public/django_aws_ses
7
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

added changelog to readme

Browse Source
This commit is contained in:
Raymond Jessop
2025-04-22 23:13:39 -05:00
parent 7b1e3bd5e7
commit 922392a332
3 changed files with 59 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
CHANGELOG.md
View File

@@ -2,23 +2,37 @@
All notable changes to `django_aws_ses` will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
## 0.1.2 - 2025-04-22
## [0.1.2] - 2025-04-22
### Added
- `CHANGELOG.md` to document version history.
- Clickable table of contents in `README.md` for improved navigation.
- Expanded `README.md` sections for AWS SES configuration and usage, with detailed instructions and AWS documentation links.
- Note in `README.md` Usage section clarifying examples are in a Python console.
### Changed
- Updated `README.md` to use `https://yourdomain.com` consistently for example URLs.
- Improved `README.md` formatting for better rendering on PyPI.
## 0.1.1 - 2025-04-22
## [0.1.1] - 2025-04-22
### Added
- Comprehensive installation steps in `README.md`, covering PyPI, and dependency options (`dev`, `dkim`).
- Comprehensive installation steps in `README.md`, covering PyPI and dependency options (`dev`, `dkim`).
- `CONTRIBUTORS.md` to acknowledge ZeeksGeeks team members and their roles.
### Changed
- Updated `README.md` formatting for better rendering on PyPI.
- Incremented version to `0.1.1` to reflect documentation improvements.
## [0.1.0] - 2025-04-15
## 0.1.0 - 2025-04-15
### Added
- Initial release of `django_aws_ses`.
- Custom Django email backend for Amazon SES.
- Bounce and complaint handling via SNS notifications.
@@ -29,9 +43,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Comprehensive test suite covering email sending, bounce/complaint handling, and unsubscribe functionality.
### Notes
- Initial release tested with Django 3.2+ and Python 3.6+.
- Successfully deployed to TestPyPI for validation.
[0.1.0.2]: https://git-vault.zeeksgeeks.com/ZeeksGeeks/django_aws_ses/compare/0.1.0.1...0.1.0.2
[0.1.0.1]: https://git-vault.zeeksgeeks.com/ZeeksGeeks/django_aws_ses/compare/0.1.0...0.1.0.1
[0.1.0]: https://git-vault.zeeksgeeks.com/ZeeksGeeks/django_aws_ses/releases/tag/0.1.0
- Initial release tested with Django 3.2+ and Python 3.6+.
- Successfully deployed to TestPyPI for validation.