Skip to content

v1.0.0 - Initial Release

Compare
Choose a tag to compare
@arunkumar9t2 arunkumar9t2 released this 09 Oct 12:37
· 9 commits to main since this release

Compass

Kotlin API and tools to make working with Realm easier

Components

Compass is designed to make working with Realm easier through collection of Kotlin types and extensions that handle Realm's lifecycle and threading model effectively. It has two major components

  • compass - The core Kotlin API with set of extensions for common patterns around Realm's lifecycle and threading.
  • compass-paging - Provides extensions to integrate with Jetpack Paging 3.
  • more coming soon..™

Getting Started

Compass is available as android library artifacts on mavenCentral. In root build.gradle:

allprojects {
  repositories {
    mavenCentral()
  }
}

Or in dependenciesResolutionManagement in settings.gradle:

dependencyResolutionManagement {
  repositories {
    mavenCentral()
  }
}

Then in your modules:

dependencies {
    implementation "dev.arunkumar.compass:compass:1.0.0"
    // Paging integration
    implementation "dev.arunkumar.compass:compass-paging:1.0.0"
}

Resources:

https://arunkumar.dev/introducing-compass-effective-paging-with-realm-and-jetpack-paging-3/