Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# Interval Annotated String

![Maven Central Version](https://img.shields.io/maven-central/v/com.justeattakeaway/interval-annotated-string)

A tiny Android utility library that simplifies the process of creating and managing embedded
links and styles within a localised text block. It provides a clean, non-disruptive syntax that
won't confuse translators, while still allowing you to identify specific parts of a string.
Expand All @@ -23,6 +25,29 @@ with custom spans, such as clickable links or different text styles.

Supports [Compose](https://developer.android.com/compose) out of the box, but is not limited to it.

## Installation

Add the following to your module's build file.

### Kotlin DSL: `build.gradle.kts`

```kotlin
dependencies {
implementation("com.justeattakeaway:interval-annotated-string:x.x.x")
}
```

### Groovy: `build.gradle`

```groovy
dependencies {
implementation 'com.justeattakeaway:interval-annotated-string:x.x.x'
}
```

> [!NOTE]
> To get the latest available version see the version badge at the top of this page.

## Usage

### Anatomy of an Interval Annotated String
Expand Down