Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
Added a post install message
  • Loading branch information
heliocola committed Apr 19, 2024
1 parent 0360df8 commit 57e561b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,19 @@ License:: MIT

RedCloth is a Ruby library for converting Textile into HTML.

== Attention - Deprecating JRuby and Windows support in version 4.3
== Attention: **BREAKING CHANGE** RedCloth 5.x series

In order to prioritize merging a fix for the long standing vulnerability *CVE-2012-6684*, our {new maintainer}[https://github.com/joshuasiler] has elected to stop maintaining the precompiled versions for Windows and JRuby.
RedCloth 5.x series will not create the the <tt>t</tt> alias by default, but will provide an extension file if you wish to continue that behavior.

Keep in mind the long term plan is to drop this all together.

== JRuby and Windows support in version 4.3

A while ago, around the time *CVE-2012-6684* was open, the {maintainer at that time}[https://github.com/joshuasiler], has elected to stop maintaining the precompiled versions for Windows and JRuby.

But there is an ongoing effort to restore JRuby support.

If this interests you, please :+1: {Issue #44}[https://github.com/jgarber/redcloth/issues/44].

== Installing

Expand Down
6 changes: 6 additions & 0 deletions redcloth.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,10 @@ Gem::Specification.new do |s|
s.add_development_dependency('rspec', '~> 3.12')
s.add_development_dependency('diff-lcs', '~> 1.5')

s.post_install_message = %q{
**BREAKING CHANGE**: RedCloth 5.x series
RedCloth 5.x series has one breaking change related to alias `t`
Please see https://github.com/jgarber/redcloth#attention-breaking-change-redcloth-5x-series-
}

end

0 comments on commit 57e561b

Please sign in to comment.