Skip to content

Commit e941ff1

Browse files
authored
Document that REXML follows the Ruby maintenance cycle (#71)
As discussed in #70 .
1 parent 072b02f commit e941ff1

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ REXML supports both tree and stream document parsing. Stream parsing is faster (
66

77
## API
88

9-
See the {API documentation}[https://ruby.github.io/rexml/]
9+
See the [API documentation](https://ruby.github.io/rexml/).
1010

1111
## Usage
1212

@@ -33,6 +33,15 @@ doc = Document.new string
3333

3434
So parsing a string is just as easy as parsing a file.
3535

36+
## Support
37+
38+
REXML support follows the same maintenance cycle as Ruby releases, as shown on <https://www.ruby-lang.org/en/downloads/branches/>.
39+
40+
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.
41+
42+
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.
43+
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).
44+
3645
## Development
3746

3847
After checking out the repo, run `rake test` to run the tests.

0 commit comments

Comments
 (0)