Dotify APIs

Provides the Dotify APIs.

Using

To implement the API, download the latest release from maven central.

To use the API, you need to download at least one implementation as well. Here's a list of known implementations:

• dotify.formatter.impl
• dotify.translator.impl
• dotify.text.impl
• dotify.hyphenator.impl
• braille-utils.impl

Building

Build with gradlew build (Windows) or ./gradlew build (Mac/Linux)

Testing

Tests are run with gradlew test (Windows) or ./gradlew test (Mac/Linux)

Requirements & Compatibility

• Requires Java 8
• Implementations can be provided with SPI and/or OSGi

Javadoc

Javadoc for the latest Dotify API development is available here.

More information

See the common wiki for more information.