aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKazuki Yamaguchi <k@rhe.jp>2023-09-10 00:49:06 +0900
committerKazuki Yamaguchi <k@rhe.jp>2023-09-10 00:49:06 +0900
commit1a97359d5fd5bbb7a1e97f0d9f0d37196d3789a6 (patch)
tree4e8ecdd94490f3b066743a8cdddd887a04b1108e
parent9b20a3d778d618882656549fb9b755b167996ceb (diff)
downloadruby-openssl-ky/release-3.2.0.tar.gz
fixup! Update README and gemspec descriptionky/release-3.2.0
-rw-r--r--README.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md
index c10579b4..3492b538 100644
--- a/README.md
+++ b/README.md
@@ -2,28 +2,28 @@
[![Actions Status](https://github.com/ruby/openssl/workflows/CI/badge.svg)](https://github.com/ruby/openssl/actions?workflow=CI)
-OpenSSL for Ruby provides access to SSL/TLS and general-purpose cryptography
-based on the OpenSSL library.
+**OpenSSL for Ruby** provides access to SSL/TLS and general-purpose
+cryptography based on the OpenSSL library.
-OpenSSL for Ruby is sometimes referred to as "openssl" (in all lowercase) or
-"Ruby/OpenSSL" for disambiguation.
+OpenSSL for Ruby is sometimes referred to as **openssl** in all lowercase
+or **Ruby/OpenSSL** for disambiguation.
## Compatibility and maintenance policy
OpenSSL for Ruby is released as a RubyGems gem. At the same time, it is part of
the standard library of Ruby. This is called a [default gem].
-Stable branches of OpenSSL for Ruby will receive security and bug fixes for the
-[lifecycle of their corresponding Ruby branch][Ruby Maintenance Branches].
-
-|Branch|Maintenance status |Ruby compatibility|OpenSSL compatibility |
-|------|-------------------------------|------------------|--------------------------------------------|
-|3.2 |normal maintenance (Ruby 3.3) |Ruby 2.7+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
-|3.1 |normal maintenance (Ruby 3.2) |Ruby 2.6+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
-|3.0 |normal maintenance (Ruby 3.1) |Ruby 2.6+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
-|2.2 |security maintenance (Ruby 3.0)|Ruby 2.3+ |OpenSSL 1.0.1-1.1.1 or LibreSSL 2.9+ |
-|2.1 |end-of-life (Ruby 2.5-2.7) |Ruby 2.3+ |OpenSSL 1.0.1-1.1.1 or LibreSSL 2.5+ |
-|2.0 |end-of-life (Ruby 2.4) |Ruby 2.3+ |OpenSSL 0.9.8-1.1.1 or LibreSSL 2.3+ |
+Each stable branch of OpenSSL for Ruby will remain supported as long as it is
+included as a default gem in [supported Ruby branches][Ruby Maintenance Branches].
+
+|OpenSSL for Ruby|Maintenance status |Ruby compatibility|OpenSSL compatibility |
+|----------------|-------------------------------|------------------|--------------------------------------------|
+|3.2 |normal maintenance (Ruby 3.3) |Ruby 2.7+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
+|3.1 |normal maintenance (Ruby 3.2) |Ruby 2.6+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
+|3.0 |normal maintenance (Ruby 3.1) |Ruby 2.6+ |OpenSSL 1.0.2-3.1 (current) or LibreSSL 3.1+|
+|2.2 |security maintenance (Ruby 3.0)|Ruby 2.3+ |OpenSSL 1.0.1-1.1.1 or LibreSSL 2.9+ |
+|2.1 |end-of-life (Ruby 2.5-2.7) |Ruby 2.3+ |OpenSSL 1.0.1-1.1.1 or LibreSSL 2.5+ |
+|2.0 |end-of-life (Ruby 2.4) |Ruby 2.3+ |OpenSSL 0.9.8-1.1.1 or LibreSSL 2.3+ |
[default gem]: https://docs.ruby-lang.org/en/master/standard_library_rdoc.html
[Ruby Maintenance Branches]: https://www.ruby-lang.org/en/downloads/branches/