From 901eab7e06e963e860c357cd9256db73d3896573 Mon Sep 17 00:00:00 2001 From: abrahamsonn Date: Tue, 14 Nov 2017 15:51:32 -0700 Subject: [PATCH] README updates to attempt to improve GitHub search positioning --- README | 27 +++++++++++++++++++++++++++ README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) diff --git a/README b/README index 7d863e118..08c7a5c31 100644 --- a/README +++ b/README @@ -1,3 +1,30 @@ +*** Description *** + +The wolfSSL embedded SSL library (formerly CyaSSL) is a lightweight SSL/TLS +library written in ANSI C and targeted for embedded, RTOS, and +resource-constrained environments - primarily because of its small size, speed, +and feature set. It is commonly used in standard operating environments as well +because of its royalty-free pricing and excellent cross platform support. wolfSSL +supports industry standards up to the current TLS 1.2 and DTLS 1.2 levels, is up +to 20 times smaller than OpenSSL, and offers progressive ciphers such as ChaCha20, +Curve25519, NTRU, and Blake2b. User benchmarking and feedback reports +dramatically better performance when using wolfSSL over OpenSSL. + +wolfSSL is powered by the wolfCrypt library. A version of the wolfCrypt +cryptography library has been FIPS 140-2 validated (Certificate #2425). For +additional information, visit the wolfCrypt FIPS FAQ +(https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com + +*** Why choose wolfSSL? *** + +There are many reasons to choose wolfSSL as your embedded SSL solution. Some of +the top reasons include size (typical footprint sizes range from 20-100 kB), +support for the newest standards (SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3, +DTLS 1.0, and DTLS 1.2), current and progressive cipher support (including stream +ciphers), multi-platform, royalty free, and an OpenSSL compatibility API to ease +porting into existing applications which have previously used the OpenSSL package. +For a complete feature list, see https://github.com/wolfSSL/wolfssl/wiki/Features. + *** Notes, Please read *** Note 1) diff --git a/README.md b/README.md index 26444bf07..5c403db5a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ +# Resources + +[wolfSSL Website](https://www.wolfssl.com/) + +[wolfSSL Wiki](https://github.com/wolfSSL/wolfssl/wiki) + +[FIPS FAQ](https://www.wolfssl.com/wolfSSL/fips.html) + +[wolfSSL Manual](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-toc.html) + +[wolfSSL API Reference](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-17-wolfssl-api-reference.html) + +[wolfCrypt API Reference](https://wolfssl.com/wolfSSL/Docs-wolfssl-manual-18-wolfcrypt-api-reference.html) + +[TLS 1.3](https://tools.ietf.org/html/draft-ietf-tls-tls13-2) + + +# Description + +The wolfSSL embedded SSL library (formerly CyaSSL) is a lightweight SSL/TLS library written in ANSI C and targeted for embedded, RTOS, and resource-constrained environments - primarily because of its small size, speed, and feature set. It is commonly used in standard operating environments as well because of its royalty-free pricing and excellent cross platform support. wolfSSL supports industry standards up to the current TLS 1.2 and DTLS 1.2 levels, is up to 20 times smaller than OpenSSL, and offers progressive ciphers such as ChaCha20, Curve25519, NTRU, and Blake2b. User benchmarking and feedback reports dramatically better performance when using wolfSSL over OpenSSL. + +wolfSSL is powered by the wolfCrypt library. A version of the wolfCrypt cryptography library has been FIPS 140-2 validated (Certificate #2425). For additional information, visit the [wolfCrypt FIPS FAQ](https://www.wolfssl.com/license/fips/) or contact fips@wolfssl.com + +## Why Choose wolfSSL? +There are many reasons to choose wolfSSL as your embedded SSL solution. Some of the top reasons include size (typical footprint sizes range from 20-100 kB), support for the newest standards (SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3, DTLS 1.0, and DTLS 1.2), current and progressive cipher support (including stream ciphers), multi-platform, royalty free, and an OpenSSL compatibility API to ease porting into existing applications which have previously used the OpenSSL package. For a complete feature list, see [Section 4.1.](https://github.com/wolfSSL/wolfssl/wiki/Features) + +*** + # Notes - Please read ## Note 1