From 5812939d7f6c8a76c01a57ebec8ebceff04b4561 Mon Sep 17 00:00:00 2001 From: Dmitriy Berdnikov Date: Mon, 13 May 2024 14:02:05 +0300 Subject: [PATCH] update README.md --- README.md | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 06609206..55149c15 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ ![Elmslie](https://user-images.githubusercontent.com/16104123/104534649-b5defa80-5625-11eb-98b6-d761623f8964.jpeg) [![](https://jitpack.io/v/diklimchuk/test.svg)](https://jitpack.io/#diklimchuk/test) -[![Jitpack badge](https://jitpack.io/v/vivid-money/elmslie.svg)](https://jitpack.io/#vivid-money/elmslie) -[![Code quality badge](https://github.com/vivid-money/elmslie/actions/workflows/codequality.yml/badge.svg?branch=main&event=push)](https://github.com/vivid-money/elmslie/actions/workflows/codequality.yml) +[![Maven Central Version](https://img.shields.io/maven-central/v/money.vivid.elmslie/elmslie-core)](https://central.sonatype.com/artifact/money.vivid.elmslie/elmslie-core) [![License badge](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Elmslie is a minimalistic reactive implementation of TEA/ELM written in kotlin with java support. @@ -10,7 +9,7 @@ Named after [George Grant Elmslie](https://en.wikipedia.org/wiki/George_Grant_El ## Why? - **Scalable and Reusable**: Built-in support for nesting components -- **Reactive**: Written with pure Kotlin, but has compatibility mode with RxJava2, RxJava3 and Coroutines +- **Multiplatform**: Written with pure Kotlin and Coroutines, supports KMP (Android, iOS, JS) - **Single immutable state**: Simplify state management - **UDF**: Say no to spaghetti code with Unidirectional Data Flow @@ -25,44 +24,30 @@ This is a visual representation of the architecture: For more info head to the [wiki](https://github.com/vivid-money/elmslie/wiki) ## Samples -Samples are available [here](https://github.com/vivid-money/elmslie/tree/main/elmslie-samples) -- Basic loader for android: [link](https://github.com/vivid-money/elmslie/tree/main/elmslie-samples/android-loader) -- Pure kotlin calculator: [link](https://github.com/vivid-money/elmslie/tree/main/elmslie-samples/kotlin-calculator) -- Pure java notes: [link](https://github.com/vivid-money/elmslie/tree/main/elmslie-samples/java-notes) -- Paging with compose: [link](https://github.com/vivid-money/elmslie/tree/main/elmslie-samples/compose-paging) - -## Code generation plugin for Android Studio -Plugin is available at the [Jetbrains plugin repository](https://plugins.jetbrains.com/plugin/17176-elmslie-generator/versions/stable/125661) -More info in the [wiki article](https://github.com/vivid-money/elmslie/wiki) +Samples are available [here](https://github.com/vivid-money/elmslie/tree/publish-elmslie-3.0/samples) +- Basic loader for android: [link](https://github.com/vivid-money/elmslie/tree/publish-elmslie-3.0/samples/coroutines-loader) +- Pure kotlin calculator: [link](https://github.com/vivid-money/elmslie/tree/publish-elmslie-3.0/samples/kotlin-calculator) ## Download Library is distributed through JitPack #### Add repository in the root build.gradle -``` +```kotlin allprojects { - repositories { - maven { url "https://jitpack.io" } - } + repositories { + mavenCentral() + } } ``` #### Add required modules: - Core - for pure kotlin ELM implementation -`implementation 'com.github.vivid-money.elmslie:elmslie-core:{latest-version}'` +`implementation 'money.vivid.elmslie:elmslie-core:{latest-version}'` - Android - for android apps only, simplifies lifecycle handling -`implementation 'com.github.vivid-money.elmslie:elmslie-android:{latest-version}'` - -- RxJava 2 - compatibility module (more info in the wiki [article](https://github.com/vivid-money/elmslie/wiki/RxJava-2-vs-3)) - -`implementation 'com.github.vivid-money.elmslie:elmslie-rxjava-2:{latest-version}'` - -- Jetpack Compose - for android apps only, simplifies using jetpack compose (not required) - -`implementation 'com.github.vivid-money.elmslie:elmslie-compose:{latest-version}'` +`implementation 'money.vivid.elmslie:elmslie-android:{latest-version}'` ## Related articles