Skip to content
This repository has been archived by the owner on Mar 21, 2023. It is now read-only.

Latest commit

 

History

History
35 lines (22 loc) · 1.51 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.51 KB

Syllable Counter

CI Status Deploy Status Maven Central version codecov

Uses a fallback method—based on the NLTK readability plugin by Thomas Jakobsen [email protected] and Thomas Skardal [email protected]. This NLTK plugin is itself based on the algorithm implemented in the Lingua::EN::Syllable perl module by Greg Fast [email protected].

Thanks to them for making their work available.

Requirements

To use this Java library, you need Java 8 and Maven 3.

Installation

Refer to the Maven Central page to find the installation instructions for your build tool or to download the jar directly.

Usage

The usage is trivial. To retrieve the number of syllables of a word, use the count method:

import eu.crydee.syllablecounter.SyllableCounter;

...

SyllableCounter sc = new SyllableCounter();
int myCount = sc.count("facility");
// myCount holds 4