Skip to content

Commit

Permalink
doc: make it easier to find changelog
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jsha authored and ctz committed Dec 1, 2023
1 parent 303b3ff commit 022042f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelog

The detailed list of changes in each release can be found at
https://github.com/rustls/rustls/releases.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 022042f

Please sign in to comment.