text-hyphen 1.4.1 → 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6691be16764f973315c67ddd1da98d90bfe79921546b519d2d0eeac65ec4b9c2
+  data.tar.gz: b5c789b5d5e18db0e1408f7de1c24b5ad2431594edd8311a263b0ae093ef96ad
+SHA512:
+  metadata.gz: b921231d274be4e5c614ddf038edd6f701d4693853eaf72a572827f3052cab456f98e6416ad751b8266b8eb59e92f298c00659f875e267ab0968b1ecab6fa3ba
+  data.tar.gz: 4608df3088f90f42af612eb01b947d28cd98be40eb393d64d812f3044c5026257066290efe46423351d3fe2688c11895f343280541a02efc04aadacbfd8a10ef

data/.standard.yml

@@ -0,0 +1,5 @@
+parallel: true
+ruby_version: 1.8
+ignore:
+  - '*.gemspec'
+  - 'lib/text/hyphen/language/1.8/*.rb'

data/Code-of-Conduct.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Contributing.md

@@ -0,0 +1,68 @@
+# Contributing
+
+I value any contribution to text-hyphen you can provide: a bug report, a feature
+request, or code contributions.
+
+There are a few guidelines for contributing to text-hyphen:
+
+- Code changes _will_ _not_ be accepted without tests. The test suite is
+  written with test/unit and will be eventually moved to [minitest][].
+- Match my coding style.
+- Use a thoughtfully-named topic branch that contains your change. Rebase your
+  commits into logical chunks as necessary.
+- Use [quality commit messages][].
+- Do not change the version number; when your patch is accepted and a release
+  is made, the version will be updated at that point.
+- Submit a GitHub pull request with your changes.
+- New or changed behaviours require new or updated documentation.
+
+### Test Dependencies
+
+text-hyphen uses Ryan Davis’s [Hoe][] to manage the release process, and it adds
+a number of rake tasks. You will mostly be interested in `rake`, which runs the
+tests the same way that `rake test` will do.
+
+To assist with the installation of the development dependencies for text-hyphen,
+I have provided the simplest possible Gemfile pointing to the (generated)
+`text-hyphen.gemspec` file. This will permit you to do `bundle install` to get
+the development dependencies. If you already have `hoe` installed, you can
+accomplish the same thing with `rake newb`.
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+You can run tests with code coverage analysis by running `rake test:coverage`.
+
+## Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+- Fork the project.
+- Clone down your fork (`git clone git://github.com/<username>/text-hyphen.git`).
+- Create a topic branch to contain your change (`git checkout -b my_awesome_feature`).
+- Hack away, add tests. Not necessarily in that order.
+- Make sure everything still passes by running `rake`.
+- If necessary, rebase your commits into logical chunks, without errors.
+- Push the branch up (`git push origin my_awesome_feature`).
+- Create a pull request against halostatue/text-hyphen and describe what
+  your change does and the why you think it should be merged.
+
+## Contributors
+
+- Austin Ziegler created text-hyphen based on TeX::Hyphen by Martin DeMello.
+
+Thanks to everyone else who has contributed to text-hyphen over the years:
+
+- anes hodza
+- Cezary Baginsky
+- Dmitry Lihachev
+- Kirill Maksimov
+- @hadmut
+- Markus (@doits)
+- Martin DeMello
+- Pavol Sopko
+- Petras Kudaras
+
+[minitest]: https://github.com/seattlerb/minitest
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[hoe]: https://github.com/seattlerb/hoe

data/History.md

@@ -0,0 +1,139 @@
+# Changelog
+
+## 1.5.0 / 2023-03-18
+
+- 1 new feature:
+
+  - anes hodza added support for phrase hyphenation in [#20][].
+
+- New hyphenation patterns:
+
+  - Pavol Sopko added Slovak hyphenation in [#12][] in 2014.
+
+  - Petras Kudaras added Lithuanian hyphenation in [#14][] in 2015.
+
+- Updated hyphenation patterns:
+
+  - Markus (@doits) updated German, English (US), and French hyphenations in 2016.
+
+- minor updates:
+
+  - Removed unused private methods
+
+- Governance changes:
+
+  - Added Contributor Covenant 1.4.
+
+  - Switched to GitHub Actions.
+
+  - Switched to Standard Ruby.
+
+- Development changes:
+
+  - The gem should install on all older version of Ruby, but as I am building
+    with Ruby 2.7, I cannot guarantee full compatibility.
+
+## 1.4.1 / 2012.08.27
+
+- 1 bug fix:
+
+  - Evgeny Lapin (<https://github.com/jenkek>) pointed out that I forgot to
+    include the new Russian-language hyphenation files, breaking the gem for use
+    with Russian. Oops.
+
+## 1.4 / 2012.08.25
+
+- 1 enhancement:
+
+  - Kirill Maksimov (<https://github.com/netoneko>) added Russian-language
+    hyphenation, complete with test. Thanks! In Ruby 1.8, the encoding is
+    KOI8-R. Also submitted by Dmitry Lihachev (<https://github.com/lda>).
+
+- 1 bug fix:
+
+  - Visualization with hyphens larger than one character (such as the HTML
+    soft-hyphen entity) would not be correct; this has been resolved. Thanks to
+    hadmut (<https://github.com/hadmut>) for reporting this issue.
+
+## 1.3 / 2012.06.20
+
+- 2 enhancements:
+
+  - Cezary Baginsky (https://github.com/e2) added the ability to specify a
+    hyphen character (such as the HTML soft-hyphen entity) instead of always
+    using the dash-hyphen.
+
+  - Added a new option to bin/ruby-hyphen to support the new feature.
+
+- 1 bug fix:
+
+  - `bin/ruby-hyphen` didn't work when visualizing to a size. Fixed.
+
+## 1.2.1 / 2012.04.05
+
+- 1 documentation update:
+
+  - Fixed some typos in the README
+
+  - Versions tested previously should continue to work. Versions not currently
+    tested were not installed on the test system.
+
+## 1.2 / 2011.07.17
+
+- 1 major enhancement:
+
+  - This release supports Ruby 1.9 with UTF-8 encodings. The language files are
+    duplicated for both Ruby 1.8 and 1.9 and the correct version is loaded based
+    on RUBY_VERSION.
+
+- 3 minor enhancements:
+
+  - Making Hungarian and Norwegian language files act like the German language
+    files (both of these languages have two alternative hyphenation tables).
+
+  - Added a Malasy language file that should work correctly.
+
+  - Cleaned up the documentation.
+
+- 1 bug fix:
+
+  - Fixed 9807 and 28128 (previously noted as not reproducible; quality
+    reproduction cases were found).
+
+- Governance changes:
+
+  - Relicensing the core library to the MIT license and attempting to clarify
+    the license situation.
+
+  - Renaming hyphen to ruby-hyphen.
+
+  - This is the final release compatible with Ruby 1.8, first release
+    compatible with Ruby 1.9.
+
+## 1.0.2 / 2011.02.09
+
+- Moved to 'hoe' and GitHub.
+
+- Preparing for 2.0 which will be Ruby 1.9-only for UTF-8.
+
+- Fixing German support (RubyForge 28498):
+
+  - Choosing 'de' as a language will load 'de1'. Choosing 'de1' or 'de2' will
+    load properly now, but they will be reported with an ISO language code of
+    'de' (new optional #isocode attribute on a language definition that will
+    override the #iso_language setting of a Text::Hyphen instance if set).
+
+  - Both 'de1' and 'de2' can be loaded simultaneously now, but the first one
+    loaded will claim the Text::Hyphen::Language::DE constant.
+
+## 1.0.1
+
+- Minor modification to the RubyGem release of Text::Hyphen to enable the
+  hyphen command-line program.
+
+## 1.0.0
+
+- Initial version based on TeX::Hyphen 0.4.0 (some changes have been
+  backported to TeX::Hyphen 0.5.0).
+
+- Incorporated many hyphenation pattern files from CTAN.

data/Licence.md

@@ -0,0 +1,159 @@
+# Licence
+
+Licensing for Text::Hyphen is unfortunately complex because of the various
+copyrights and licenses of the source hyphenation files that have been converted
+to Ruby format. Some of these files are available only under the TeX license and
+others are available only under the GNU GPL while others are public domain. Each
+language file has these licenses embedded within the file. Please consult each
+file's license to ensure that it is compatible with your application.
+
+The Text::Hyphen library software, the application ruby-hyphen, and the library
+(gem) as a compilation is licensed under the terms of the MIT license. The files
+in this distribution covered by this license are in the list below called
+"Library Files".
+
+Individual language hyphenation files (in the list called "Language Files") are
+maintained under the license described in the language file itself; the
+copyright for these original files is held by the original authors; any mistakes
+made in conversion of these files to Ruby is attributable to the contributors of
+the Text::Hyphen package only. If license information is not present in a given
+Language File, it should be considered under the terms of TeX.
+
+## Library License
+
+- Copyright Austin Ziegler, 2004–2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+The copyright on the Text::Hyphen application/library and the Ruby translations
+of hyphenation files belongs to Austin Ziegler. All other copyrights on original
+versions still stand; Text::Hyphen is a derivative work of these and other
+projects.
+
+## Library Files
+
+Note that while this list appears to include language files, these are "loader"
+files only and do not contain the hyphenation patterns themselves.
+
+- `lib/text-hyphen.rb`
+- `lib/text/hyphen.rb`
+- `lib/text/hyphen/language.rb`
+- `lib/text/hyphen/language/ca.rb`
+- `lib/text/hyphen/language/cs.rb`
+- `lib/text/hyphen/language/da.rb`
+- `lib/text/hyphen/language/de.rb`
+- `lib/text/hyphen/language/de1.rb`
+- `lib/text/hyphen/language/de2.rb`
+- `lib/text/hyphen/language/en_uk.rb`
+- `lib/text/hyphen/language/en_us.rb`
+- `lib/text/hyphen/language/es.rb`
+- `lib/text/hyphen/language/et.rb`
+- `lib/text/hyphen/language/eu.rb`
+- `lib/text/hyphen/language/fi.rb`
+- `lib/text/hyphen/language/fr.rb`
+- `lib/text/hyphen/language/ga.rb`
+- `lib/text/hyphen/language/hr.rb`
+- `lib/text/hyphen/language/hsb.rb`
+- `lib/text/hyphen/language/hu.rb`
+- `lib/text/hyphen/language/hu1.rb`
+- `lib/text/hyphen/language/hu2.rb`
+- `lib/text/hyphen/language/ia.rb`
+- `lib/text/hyphen/language/id.rb`
+- `lib/text/hyphen/language/is.rb`
+- `lib/text/hyphen/language/it.rb`
+- `lib/text/hyphen/language/la.rb`
+- `lib/text/hyphen/language/mn.rb`
+- `lib/text/hyphen/language/ms.rb`
+- `lib/text/hyphen/language/nl.rb`
+- `lib/text/hyphen/language/no.rb`
+- `lib/text/hyphen/language/no1.rb`
+- `lib/text/hyphen/language/no2.rb`
+- `lib/text/hyphen/language/pl.rb`
+- `lib/text/hyphen/language/pt.rb`
+- `lib/text/hyphen/language/sv.rb`
+- `test/data/bug_9807_latin1.rb`
+- `test/data/bug_9807_utf-8.rb`
+- `test/test_bugs.rb`
+- `test/test_text_hyphen.rb`
+- `text-hyphen.gemspec`
+- `History.rdoc`
+- `License.rdoc`
+- `README.rdoc`
+- `Rakefile`
+- `bin/ruby-hyphen`
+
+## Language Files
+
+- `lib/text/hyphen/language/1.8/ca.rb`
+- `lib/text/hyphen/language/1.8/cs.rb`
+- `lib/text/hyphen/language/1.8/da.rb`
+- `lib/text/hyphen/language/1.8/de1.rb`
+- `lib/text/hyphen/language/1.8/de2.rb`
+- `lib/text/hyphen/language/1.8/en_uk.rb`
+- `lib/text/hyphen/language/1.8/en_us.rb`
+- `lib/text/hyphen/language/1.8/es.rb`
+- `lib/text/hyphen/language/1.8/et.rb`
+- `lib/text/hyphen/language/1.8/eu.rb`
+- `lib/text/hyphen/language/1.8/fi.rb`
+- `lib/text/hyphen/language/1.8/fr.rb`
+- `lib/text/hyphen/language/1.8/ga.rb`
+- `lib/text/hyphen/language/1.8/hr.rb`
+- `lib/text/hyphen/language/1.8/hsb.rb`
+- `lib/text/hyphen/language/1.8/hu1.rb`
+- `lib/text/hyphen/language/1.8/hu2.rb`
+- `lib/text/hyphen/language/1.8/ia.rb`
+- `lib/text/hyphen/language/1.8/id.rb`
+- `lib/text/hyphen/language/1.8/is.rb`
+- `lib/text/hyphen/language/1.8/it.rb`
+- `lib/text/hyphen/language/1.8/la.rb`
+- `lib/text/hyphen/language/1.8/mn.rb`
+- `lib/text/hyphen/language/1.8/nl.rb`
+- `lib/text/hyphen/language/1.8/no1.rb`
+- `lib/text/hyphen/language/1.8/no2.rb`
+- `lib/text/hyphen/language/1.8/pl.rb`
+- `lib/text/hyphen/language/1.8/pt.rb`
+- `lib/text/hyphen/language/1.8/sv.rb`
+- `lib/text/hyphen/language/1.9/ca.rb`
+- `lib/text/hyphen/language/1.9/cs.rb`
+- `lib/text/hyphen/language/1.9/da.rb`
+- `lib/text/hyphen/language/1.9/de1.rb`
+- `lib/text/hyphen/language/1.9/de2.rb`
+- `lib/text/hyphen/language/1.9/en_uk.rb`
+- `lib/text/hyphen/language/1.9/en_us.rb`
+- `lib/text/hyphen/language/1.9/es.rb`
+- `lib/text/hyphen/language/1.9/et.rb`
+- `lib/text/hyphen/language/1.9/eu.rb`
+- `lib/text/hyphen/language/1.9/fi.rb`
+- `lib/text/hyphen/language/1.9/fr.rb`
+- `lib/text/hyphen/language/1.9/ga.rb`
+- `lib/text/hyphen/language/1.9/hr.rb`
+- `lib/text/hyphen/language/1.9/hsb.rb`
+- `lib/text/hyphen/language/1.9/hu1.rb`
+- `lib/text/hyphen/language/1.9/hu2.rb`
+- `lib/text/hyphen/language/1.9/ia.rb`
+- `lib/text/hyphen/language/1.9/id.rb`
+- `lib/text/hyphen/language/1.9/is.rb`
+- `lib/text/hyphen/language/1.9/it.rb`
+- `lib/text/hyphen/language/1.9/la.rb`
+- `lib/text/hyphen/language/1.9/mn.rb`
+- `lib/text/hyphen/language/1.9/nl.rb`
+- `lib/text/hyphen/language/1.9/no1.rb`
+- `lib/text/hyphen/language/1.9/no2.rb`
+- `lib/text/hyphen/language/1.9/pl.rb`
+- `lib/text/hyphen/language/1.9/pt.rb`
+- `lib/text/hyphen/language/1.9/sv.rb`

data/Manifest.txt

@@ -1,8 +1,10 @@
-.autotest
-History.rdoc
-License.rdoc
+.standard.yml
+Code-of-Conduct.md
+Contributing.md
+History.md
+Licence.md
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 bin/ruby-hyphen
 lib/text-hyphen.rb
@@ -30,6 +32,7 @@ lib/text/hyphen/language/1.8/id.rb
 lib/text/hyphen/language/1.8/is.rb
 lib/text/hyphen/language/1.8/it.rb
 lib/text/hyphen/language/1.8/la.rb
+lib/text/hyphen/language/1.8/lt.rb
 lib/text/hyphen/language/1.8/mn.rb
 lib/text/hyphen/language/1.8/nl.rb
 lib/text/hyphen/language/1.8/no1.rb
@@ -37,6 +40,7 @@ lib/text/hyphen/language/1.8/no2.rb
 lib/text/hyphen/language/1.8/pl.rb
 lib/text/hyphen/language/1.8/pt.rb
 lib/text/hyphen/language/1.8/ru.rb
+lib/text/hyphen/language/1.8/sk.rb
 lib/text/hyphen/language/1.8/sv.rb
 lib/text/hyphen/language/1.9/ca.rb
 lib/text/hyphen/language/1.9/cs.rb
@@ -60,6 +64,7 @@ lib/text/hyphen/language/1.9/id.rb
 lib/text/hyphen/language/1.9/is.rb
 lib/text/hyphen/language/1.9/it.rb
 lib/text/hyphen/language/1.9/la.rb
+lib/text/hyphen/language/1.9/lt.rb
 lib/text/hyphen/language/1.9/mn.rb
 lib/text/hyphen/language/1.9/nl.rb
 lib/text/hyphen/language/1.9/no1.rb
@@ -67,6 +72,7 @@ lib/text/hyphen/language/1.9/no2.rb
 lib/text/hyphen/language/1.9/pl.rb
 lib/text/hyphen/language/1.9/pt.rb
 lib/text/hyphen/language/1.9/ru.rb
+lib/text/hyphen/language/1.9/sk.rb
 lib/text/hyphen/language/1.9/sv.rb
 lib/text/hyphen/language/ca.rb
 lib/text/hyphen/language/cs.rb
@@ -92,6 +98,7 @@ lib/text/hyphen/language/id.rb
 lib/text/hyphen/language/is.rb
 lib/text/hyphen/language/it.rb
 lib/text/hyphen/language/la.rb
+lib/text/hyphen/language/lt.rb
 lib/text/hyphen/language/mn.rb
 lib/text/hyphen/language/ms.rb
 lib/text/hyphen/language/nl.rb
@@ -101,9 +108,9 @@ lib/text/hyphen/language/no2.rb
 lib/text/hyphen/language/pl.rb
 lib/text/hyphen/language/pt.rb
 lib/text/hyphen/language/ru.rb
+lib/text/hyphen/language/sk.rb
 lib/text/hyphen/language/sv.rb
 test/data/bug_9807_latin1.rb
 test/data/bug_9807_utf-8.rb
 test/test_bugs.rb
 test/test_text_hyphen.rb
-text-hyphen.gemspec

data/README.md

@@ -0,0 +1,81 @@
+# text-hyphen
+
+- home :: https://rubygems.org/gems/text-hyphen
+- issues :: https://rubygems.org/gems/text-hyphen/issues
+
+## Description
+
+Text::Hyphen is a Ruby library to hyphenate words in various languages using
+Ruby-fied versions of TeX hyphenation patterns. It will properly hyphenate
+various words according to the rules of the language the word is written in. The
+algorithm is based on that of the TeX typesetting system by Donald E. Knuth.
+
+This is originally based on the Perl implementation of [TeX::Hyphen][] and the
+[Ruby port][]. The language hyphenation pattern files are based on the sources
+available from [CTAN][] as of 2004.12.19 and have been manually translated by
+Austin Ziegler.
+
+This is a small feature release adding Russian language support and fixing a bug
+in the custom hyphen support introduced last version. This release provides both
+Ruby 1.8.7 and Ruby 1.9.2 support (but please read below). In short, Ruby 1.8
+support is deprecated and I will not be providing any bug fixes related to Ruby
+1.8. New features will be developed and tested against Ruby 1.9 only.
+
+## Synopsis
+
+```ruby
+require "text/hyphen"
+
+hh = Text::Hyphen.new(language: 'en_us', left: 2, right: 2)
+# which is the same as
+hh = Text::Hyphen.new
+
+word = "representation"
+points = hh.hyphenate(word) #=> [3, 5, 8, 10]
+puts hh.visualize(word) #=> rep-re-sen-ta-tion
+
+# Phrases are also supported
+phrase = "This useful library supports sentences."
+points = hh.hyphenate(phrase)  #=> [8, 14, 23, 27, 34, 44]
+puts hh.visualize(phrase)      #=> This use-ful li-brary sup-port-s phras-es and sen-tences.
+```
+
+Both visualize and hyphenate_to methods allow choosing a custom hyphen:
+
+```ruby
+puts hh.visualize(word, "­") #=> rep­re­sen­ta­tion
+```
+
+Text::Hyphen is truly multilingual, with 29 languages or language variants
+supported. As an example, consider the difference between the following:
+
+```ruby
+require 'text/hyphen'
+
+# Using left and right minimum values of 0 ensures that you will see all
+# possible hyphenation points, not just those that meet the minimum width
+# requirements.
+en = Text::Hyphen.new(left: 0, right: 0)
+fr = Text::Hyphen.new(language: "fr", left: 0, right: 0)
+
+puts en.visualise("organiser") #=> or-gan-iser
+puts fr.visualise("organiser") #=> or-ga-ni-ser
+```
+
+As you can see, the hyphenation is distinct between the two hyphenators.
+Improvements over TeX::Hyphen include thread safety (except for debug control)
+and support for UTF-8 under Ruby 1.9.
+
+## Install
+
+gem install text-hyphen
+
+### A Note About Support on Older Rubies
+
+There is no explicit support for any version of Ruby older than 2.6, but none of
+the code has been updated and support for version back to 1.8.7 _should_
+continue to work.
+
+[TeX::Hyphen]: http://search.cpan.org/author/JANPAZ/TeX-Hyphen-0.140/lib/TeX/Hyphen.pm
+[Ruby port]: https://github.com/halostatue/tex-hyphen
+[CTAN]: https://www.ctan.org