/periodik

Periodik is a read-only property delegate that can provide a value refreshed periodically

Primary LanguageKotlinMIT LicenseMIT

Periodik

Periodik is a read-only property delegate that can provide a value updated periodically. It is inspired by periodic.

Latest Version Kotlin Version Java Version
0.1.0 1.9.22 17

Table of Contents

  1. Modules
  2. Examples
  3. Development & Testing
  4. Releases
  5. Contributing
  6. License

Modules

This project consists of following modules. You can click on a module for more information and detailed instructions.

Name Details Documentation
core Core implementation
slf4j SLF4J integration

Examples

There is an example project on https://github.com/makiftutuncu/periodik-example.

Development & Testing

This project is written in Kotlin and built with Gradle. Standard Gradle tasks like clean, compileKotlin, compileTestKotlin and test can be used during development and testing.

If you don't have Gradle installed, you can replace gradle commands with ./gradlew to use Gradle wrapper.

To test your changes during development:

  1. Bump your version in build.gradle.kts and append -SNAPSHOT.
  2. Run gradle publishToMavenLocal to publish artifacts with your changes to your local Maven repository.
  3. In the project you use periodik, update the version of periodik dependencies to your new snapshot version. Make sure you have mavenLocal() in your repositories in your build definition for this to work.

Releases

Artifacts of this project are published to Maven Central along with their sources and documentations. They are versioned according to semantic versioning. CI/CD is managed by GitHub Actions. See .github for more details on these workflows.

Contributing

All contributions are welcome, including requests to highlight your project using this library. Please feel free to send a pull request. Thank you.

License

This project is licensed with MIT License. See LICENSE for more details.