From f2564b86d0893fa3171988d57a14e28b4dafb39c Mon Sep 17 00:00:00 2001 From: Steven Roose Date: Wed, 14 Aug 2024 16:06:28 +0100 Subject: [PATCH] Make changelogs more discoverable Add links to the README and also add a workspace root dummy CHANGELOG file with the same links. This is Steven's patch from #3169 shepherded in by me. Co-developed-by: Steven Roose --- CHANGELOG.md | 12 ++++++++++++ README.md | 11 ++++++++--- 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..bef93f09b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ + +A changelog is kept per crate, see: + +- [`bitcoin` CHANGELOG](bitcoin/CHANGELOG.md) +- [`addresses` CHANGELOG](addresses/CHANGELOG.md) +- [`base58` CHANGELOG](base58/CHANGELOG.md) +- [`hashes` CHANGELOG](hashes/CHANGELOG.md) +- [`internals` CHANGELOG](internals/CHANGELOG.md) +- [`io` CHANGELOG](io/CHANGELOG.md) +- [`primitives` CHANGELOG](primitives/CHANGELOG.md) +- [`units` CHANGELOG](units/CHANGELOG.md) + diff --git a/README.md b/README.md index f5e09e65f..970192a1a 100644 --- a/README.md +++ b/README.md @@ -202,9 +202,14 @@ Our code is public domain so by all means fork it and go wild :) Release notes are done per crate, see: -- [bitcoin CHANGELOG](bitcoin/CHANGELOG.md) -- [hashes CHANGELOG](hashes/CHANGELOG.md) -- [internals CHANGELOG](internals/CHANGELOG.md) +- [`bitcoin` CHANGELOG](bitcoin/CHANGELOG.md) +- [`addresses` CHANGELOG](addresses/CHANGELOG.md) +- [`base58` CHANGELOG](base58/CHANGELOG.md) +- [`hashes` CHANGELOG](hashes/CHANGELOG.md) +- [`internals` CHANGELOG](internals/CHANGELOG.md) +- [`io` CHANGELOG](io/CHANGELOG.md) +- [`primitives` CHANGELOG](primitives/CHANGELOG.md) +- [`units` CHANGELOG](units/CHANGELOG.md) ## Licensing