From 022042f17cf20765fdc953495fa0eb4a040e0682 Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Thu, 30 Nov 2023 11:40:08 -0800 Subject: [PATCH] doc: make it easier to find changelog Many projects use CHANGELOG.md to convey their list of changes. Add a link there. In README.md, instead of describing "release history", use the "Changelog" terminology. --- CHANGELOG.md | 4 ++++ README.md | 5 +++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..8f9bad95 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Changelog + +The detailed list of changes in each release can be found at +https://github.com/rustls/rustls/releases. diff --git a/README.md b/README.md index 840a44f4..803a124c 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,10 @@ If you'd like to help out, please see [CONTRIBUTING.md](CONTRIBUTING.md). [![Documentation](https://docs.rs/rustls/badge.svg)](https://docs.rs/rustls/) [![Chat](https://img.shields.io/discord/976380008299917365?logo=discord)](https://discord.gg/MCSB76RU96) -## Release history +## Changelog -Release history can be found [on GitHub](https://github.com/rustls/rustls/releases). +The detailed list of changes in each release can be found at +https://github.com/rustls/rustls/releases. # Documentation