From e752f5553e966428fb093452f6cbf3a0fa87c710 Mon Sep 17 00:00:00 2001 From: Lukas Burkhalter Date: Wed, 12 Jun 2024 11:21:01 +0200 Subject: [PATCH] docs(readme): Add info about v2 support --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 4488e487..a67a9f48 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ crypto library](https://github.com/ProtonMail/go-crypto/tree/version-2). - [GopenPGP V3](#gopenpgp-v3) + - [GopenPGP V2 support](#gopenpgp-v2-support) - [Download/Install](#downloadinstall) - [Documentation](#documentation) - [Examples](#examples) @@ -21,6 +22,14 @@ crypto library](https://github.com/ProtonMail/go-crypto/tree/version-2). +## GopenPGP V2 support + +While GopenPGP V3 introduces a new API with significant enhancements, it is not backward compatible with GopenPGP V2. +Although we recommend upgrading to V3 for the latest features and improvements, we continue to support GopenPGP V2. +Our support includes ongoing bug fixes and minor feature updates to ensure stability and functionality for existing users. + +You can access GopenPGP V2 on the [v2 branch of this repository](https://github.com/ProtonMail/gopenpgp/tree/v2). + ## Download/Install To use GopenPGP with [Go Modules](https://github.com/golang/go/wiki/Modules) just run