Skip to content

mephistolie/compost

Repository files navigation

Release

Compost is a kit of utility functions for Jetpack Compose that aim to speed up writing of common or simple things.

Modules

🔧 Core

A library that provides useful modifiers, shapes, scope extensions, etc.

UI

A library that provide reusable animated UI-components.

📱 Demo

Android Demo App with library features.

Implementation

To start you must add JitPack Repository to your project.

Then add the following line in your app module:

Groovy
dependencies {
    ...
    implementation 'com.github.mephistolie:compost:<version>'
    ...
}
Kotlin
dependencies {
    ...
    implementation("com.github.mephistolie:compost:<version>")
    ...
}

Compost is a multimodule library, so you can implement just modules you need:

NameImplementation
Corecom.github.mephistolie.compost:compost-core
UIcom.github.mephistolie.compost:compost-ui

Contributions

Compost is a collection of independent useful things, so community defines it. Please contribute - we are happy to merge it!

Please use GitFlow and Conventional Commits to keep Git history clean:

  • feature/XXX for new stuff
  • refactor/XXX for improving existing stuff
  • fix/XXX for bug fixes

If you add new features, describe it in suitable README. Every feature should have documentation in code, description in README.md and demonstration at demo app.

If you add someone else's code to collection, make sure that you do not violate the rights and added link to source.