From 25d666b70ef31621cf5880bfe2e52b69685ca7ee Mon Sep 17 00:00:00 2001
From: Roberto Nobrega <rwnobrega@gmail.com>
Date: Fri, 29 Nov 2024 22:27:11 -0300
Subject: [PATCH] Add changelog section to README and create CHANGELOG.md with
 version `0.10.0`

---
 CHANGELOG.md | 27 +++++++++++++++++++++++++++
 README.md    |  4 ++++
 2 files changed, 31 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..70a37e58
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,27 @@
+# Changelog
+
+> [!NOTE]
+> Changelog started with version v0.10.0.
+
+## v0.10.0
+
+### Added
+
+- Implemented [relative entropy](https://komm.dev/ref/relative_entropy) (KL divergence) function.
+- Implemented [Slepian array](https://komm.dev/ref/SlepianArray).
+- Implemented [Lloyd-Max quantizer](https://komm.dev/ref/LloydMaxQuantizer).
+- Implemented [Z-Channel](https://komm.dev/ref/ZChannel).
+- Implemented [lexicodes](https://komm.dev/ref/Lexicode).
+- Added progress bar (via `tqdm`) to potential slow methods.
+
+### Breaking changes
+
+- Converted cached properties to cached methods.
+  - In `BlockCode`: `codewords`, `codeword_weight_distribution`, `minimum_distance`, `coset_leaders`, `coset_leader_weight_distribution`, `packing_radius`, and `covering_radius`.
+  - In `ReedMullerCode`: `reed_partitions`.
+- In `UniformQuantizer`:
+  - Replaced `input_peak` with `input_range`.
+  - Removed `'unquant'` choice (use `input_range=(0.0, input_peak)` and `choice="mid-tread"` instead).
+- Converted the classes `BinaryErasureChannel`, `BinarySymmetricChannel`, `DiscreteMemorylessChannel`, `AWGNChannel`, `FixedToVariableEncoder`, `FixedToVariableDecoder`, `VariableToFixedEncoder`, `VariableToFixedDecoder`, and `DiscreteMemorylessSource` from mutable to immutable.
+- Removed `RationalPolynomial` and `RationalPolynomialFraction` classes.
+- Refactored _algebra_ and _pulse_ modules. See documentation for new usage.
diff --git a/README.md b/README.md
index dc4de587..32b46845 100644
--- a/README.md
+++ b/README.md
@@ -78,3 +78,7 @@ There are some demos available in the `demo` directory. They are written using [
 ```bash
 streamlit run demo/index.py
 ```
+
+## Changelog
+
+See the [CHANGELOG.md](CHANGELOG.md).