Skip to content

Commit 854b674

Browse files
committed
docs: add v1.0.2 changelog entry
- Document fix for compare method using compact format - Add release notes for v1.0.2 (legacy branch)
1 parent 494cc20 commit 854b674

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,32 @@ All notable changes to the **legacy version** of `toon-php` (PHP 7.0-8.0) will b
44

55
> **For the latest version (PHP 8.1+)**, see the [main branch CHANGELOG](https://github.com/iamgerwin/toon-php/blob/main/CHANGELOG.md)
66
7+
## v1.0.2 - Compare Method Fix - 2026-01-25
8+
9+
### Fixed
10+
- **`Toon::compare()` now always uses `compact()` format** instead of accepting an `$options` parameter
11+
- Removed confusing `$options` parameter to simplify API
12+
- Ensures `compare` method consistently demonstrates TOON's best-case token savings
13+
- Updated docblock to clarify that compact format is used for comparison
14+
15+
### Impact
16+
17+
The `compare` method is designed to showcase TOON's benefits over JSON. This fix ensures that:
18+
19+
- Comparisons always use the most token-efficient format (compact)
20+
- Users see optimal, consistent token savings when using `compare()`
21+
- The API is simpler and less error-prone
22+
23+
### Installation
24+
25+
```bash
26+
# Automatic (Composer selects v1.x for PHP 7.0-8.0)
27+
composer require iamgerwin/toon-php
28+
29+
# Force v1.x
30+
composer require iamgerwin/toon-php:^1.0
31+
```
32+
733
## 1.0.1 - 2025-11-09
834

935
### Changed

0 commit comments

Comments
 (0)