commit 63ffdabd94070e4604584fe36708d1db3b6b29fc
parent 7613937e679fe6422dddb7d6ad2bd6d78f050110
Author: BrookJeynes <jeynesbrook@gmail.com>
Date: Wed, 26 Mar 2025 07:27:51 +1000
docs: added changelog
Diffstat:
1 file changed, 39 insertions(+), 0 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,39 @@
+# Changelog
+
+## v1.2.1 (2025-03-26)
+- chore: Update project to Zig v0.14.0
+
+## v1.2.0 (2025-01-09)
+- feat: Added the ability to colour progress bar.
+- feat: Added option to show background character for progress bar.
+- chore: Updated examples to showcase new colour options.
+- refactor: Renamed escape_codes.zig to ansi-term.zig and added correct
+ copyright attribution.
+
+## v1.1.0 (2024-10-28)
+- Progress bar now supports u21 ascii characters.
+- Updated bar/complex.zig example to showcase this.
+- Added new `completionCharacter` config. This character, if defined,
+ gets printed instead of the spinner symbol on `Spinner.finish()`.
+- `updateDescriptionNewline` allows you to now retain the previous
+ spinner symbol / description on the previous line and start a new task
+ on the next. This goes hand in hand with the new `completionCharacter`
+ config.
+- Updated casing from `update_description()` to `updateDescription()`.
+- Update doc strings to make render functionality for spinners more obvious.
+
+## v1.0.0 (2024-07-18)
+- Added spinners! Check out `examples/spinner` for api usage or check
+ the docs `zig build docs`.
+- Renamed `progress.zig` to `bar.zig`. This change came from the need
+ of having two progress variants, `bar.zig -> Bar` and `spinner.zig ->
+ Spinner`.
+- Added `Bar.isCurrent()` as a thread safe way of checking the current
+ progress of a progress bar.
+- Updated and split up examples, `examples/bar` and `examples/spinner`.
+- Updated `build.zig` to allow running both spinner and bar examples,
+ e.g. `zig build run-bar-complex` vs `zig build run-spinner-complex`.
+- Updated `README` with new examples.
+- Updated docstrings in `bar.zig`
+- `Bar.finish()` can now error. This was always the intent but I missed
+ a `!`... whoops. This is now fixed.