From 98e0129d6f71724acf3774ed1461533e519c8ed7 Mon Sep 17 00:00:00 2001 From: Frank Denis Date: Wed, 31 Dec 2025 23:00:37 +0100 Subject: [PATCH] Clarify versioning --- README.markdown | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 976c920a..d3acd7a0 100644 --- a/README.markdown +++ b/README.markdown @@ -22,17 +22,22 @@ It is a portable, cross-compilable, installable, and packageable fork of [NaCl]( ## Documentation -Detailed documentation is available online. It is generated from the [libsodium-doc](https://github.com/jedisct1/libsodium-doc) repository and requires JavaScript for full functionality: - -- [libsodium Documentation](https://doc.libsodium.org) +- [Installation](https://doc.libsodium.org/installation) +- [Quickstart](https://doc.libsodium.org/quickstart) +- [Full Documentation](https://doc.libsodium.org) +- [Releases](https://download.libsodium.org/libsodium/releases/) +- [Integrity Checking](https://doc.libsodium.org/installation#integrity-checking) --- -## Integrity Checking +## Versioning -For security and authenticity, please review the integrity checking instructions. These include the signing keys and methods to verify your installation: +libsodium uses a two-tier release system: -- [Integrity Checking Instructions](https://download.libsodium.org/doc/installation#integrity-checking) +- **Point releases** (e.g., 1.0.19, 1.0.20, 1.0.21) are tagged when new features are added or significant changes are made. +- **Stable releases** are frequent maintainance updates between point releases. They fix minor issues while remaining fully compatible with their parent point release. No new features, no breaking changes. + +If your application depends on a specific point release, stable updates are safe to apply. Security fixes go to the `stable` branch immediately, with a new point release tagged shortly after. ---