aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Rodgman <dave.rodgman@arm.com>2021-04-23 16:43:13 +0100
committerDave Rodgman <dave.rodgman@arm.com>2021-04-26 16:23:21 +0100
commita00e8502c9d027b8e121eed90e5a3780625cb214 (patch)
treecebe2008223c2a7fbd9532b8ed0e425c3da9a761 /README.md
parent5ec69069640838754a9b4e87907f9fd613acdefc (diff)
downloadmbedtls-a00e8502c9d027b8e121eed90e5a3780625cb214.zip
mbedtls-a00e8502c9d027b8e121eed90e5a3780625cb214.tar.gz
mbedtls-a00e8502c9d027b8e121eed90e5a3780625cb214.tar.bz2
Documentation updates for Mbed TLS 3.0
Update documentation to reflect the branch changes. Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 759ffb5..ee6ad52 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@ Mbed TLS is a C library that implements cryptographic primitives, X.509 certific
Mbed TLS includes a reference implementation of the [PSA Cryptography API](#psa-cryptography-api). This is currently a preview for evaluation purposes only.
+Stability
+---------
+
+**Warning: the [`development`](https://github.com/ARMmbed/mbedtls/tree/development) branch of Mbed TLS currently has an unstable API.** It is where work is happening on the next major release of Mbed TLS. Until Mbed TLS 3.0 is released, if you need a stable API, please use the branch [`development_2.x`](https://github.com/ARMmbed/mbedtls/tree/development_2.x) instead.
+
Configuration
-------------