Post install message

jgarber · Apr 18, 2024 · a8e1662 · a8e1662
1 parent 28d0f45
commit a8e1662
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.rdoc b/README.rdoc
@@ -14,7 +14,7 @@ RedCloth is a Ruby library for converting Textile into HTML.
 
 == Attention: **BREAKING CHANGE** RedCloth 5.x series
 
-RedCloth 5.x series will not create the the `t` alias by default, but will provide an extension file if you wish to continue that behavior.
+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.
 

diff --git a/redcloth.gemspec b/redcloth.gemspec
@@ -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/README.rdoc#attention-breaking-change-redcloth-5x-series-
+  }
+
 end