Skip to content

Commit ebf0837

Browse files
committed
docs: add changelog and versioning policy
1 parent bed02e4 commit ebf0837

2 files changed

Lines changed: 29 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [v1.0.3] - 2025-09-10
6+
- Added pkg-config template and vcpkg overlay port.
7+
- Added optional NTP client install toggle and configuration flags.
8+
- Expanded time parser tests and DST boundary coverage.
9+
- Lowered minimum required CMake version to 3.15.
10+
- Improved installation and consumer build scripts.
11+
12+
## [v1.0.2] - 2025-07-20
13+
- Removed invalid const qualifiers from return types in time utilities.
14+
- Fixed compiler warnings and added dt_to_timestamp example.
15+
16+
## [v1.0.1] - 2025-06-25
17+
- Optimized sec_of_day and other parsing helpers.
18+
- Added WinSock-based NtpClient and timezone conversion utilities.
19+
- Provided usage examples and expanded documentation.
20+
21+
## [v1.0.0] - 2025-06-21
22+
- Initial release with MQL5 Unix year helpers.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@ Use `time_shield::` or `using namespace time_shield;` to access the API.
8383
- Core functions avoid throwing exceptions and do not allocate dynamic memory;
8484
helpers returning `std::string` rely on the caller to manage allocations.
8585

86+
## Versioning
87+
88+
Time Shield follows [Semantic Versioning](https://semver.org). Patch releases
89+
contain only backward-compatible fixes. Minor versions add
90+
backward-compatible features. Major versions may include breaking changes. The
91+
public API comprises headers under `include/time_shield`.
92+
8693
## Installation
8794

8895
### Install and `find_package`

0 commit comments

Comments
 (0)