Skip to content

Commit 637283e

Browse files
chore: Add initial changelog file following Keep a Changelog format
1 parent be02cdd commit 637283e

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
-
12+
13+
### Changed
14+
-
15+
16+
### Deprecated
17+
-
18+
19+
### Removed
20+
-
21+
22+
### Fixed
23+
-
24+
25+
### Security
26+
-
27+
28+
## [1.0.0] - 2026-05-16
29+
30+
### Added
31+
- Core Caesar cipher encryption and decryption functionality
32+
- Customizable shift parameter for encryption/decryption
33+
- Support for altering digits (`alterNumbers` / `isNumbersAltered` flags)
34+
- Support for altering symbols (`alterSymbols` / `isSymbolsAltered` flags)
35+
- File-based encryption via `encrypt_file()` method
36+
- File-based decryption via `decrypt_file()` method
37+
- Input validation for text, shift values, and file operations
38+
- Intuitive API with `Encryption` and `Decryption` classes
39+
- Basic emoji support for encryption and decryption
40+
- Support for both uppercase and lowercase letters
41+
- Comprehensive unit tests for encryption and decryption functionality
42+
- File I/O tests for encrypt/decrypt file operations
43+
- PyPI package distribution
44+
- GitHub Actions CI/CD pipeline for automated testing
45+
- Comprehensive documentation and usage examples
46+
47+
[unreleased]: https://github.com/ViratiAkiraNandhanReddy/CaesarCipher.extended-python.pypi/compare/v1.0.0...HEAD
48+
[1.0.0]: https://github.com/ViratiAkiraNandhanReddy/CaesarCipher.extended-python.pypi/releases/tag/v1.0.0

0 commit comments

Comments
 (0)