From e941ff17ed3dad428d946b15524bb3529e684266 Mon Sep 17 00:00:00 2001 From: Ivo Anjo Date: Sat, 10 Apr 2021 21:52:41 +0100 Subject: [PATCH] Document that REXML follows the Ruby maintenance cycle (#71) As discussed in #70 . --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27da0e49..e8ab5082 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ REXML supports both tree and stream document parsing. Stream parsing is faster ( ## API -See the {API documentation}[https://ruby.github.io/rexml/] +See the [API documentation](https://ruby.github.io/rexml/). ## Usage @@ -33,6 +33,15 @@ doc = Document.new string So parsing a string is just as easy as parsing a file. +## Support + +REXML support follows the same maintenance cycle as Ruby releases, as shown on . + +If you are running on an end-of-life Ruby, do not expect modern REXML releases to be compatible with it; in fact, it's recommended that you DO NOT use this gem, and instead use the REXML version that came bundled with your end-of-life Ruby version. + +The `required_ruby_version` on the gemspec is kept updated on a [best-effort basis](https://github.com/ruby/rexml/pull/70) by the community. +Up to version 3.2.5, this information was not set. That version [is known broken with at least Ruby < 2.3](https://github.com/ruby/rexml/issues/69). + ## Development After checking out the repo, run `rake test` to run the tests.