From 7df54d869c23a38696e4f9e749fab377787d8562 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Miguel=20Rubio?= Date: Fri, 27 Sep 2024 10:25:46 +0200 Subject: [PATCH] Update README.md --- README.md | 49 +------------------------------------------------ 1 file changed, 1 insertion(+), 48 deletions(-) diff --git a/README.md b/README.md index 2bf1213e0..b798b3f1b 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,6 @@ # DHIS2 Mobile UI -> **@dhis2/dhis2-mobile-ui** is -> a [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) DHIS2 design system -> library for [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) applications. - -**DHIS2 Mobile UI library** is based in -the [DHIS2 Mobile Design System Figma library](https://www.figma.com/file/eRk6bt0B8BJlTO9PZXirHN/DHIS2-Mobile-Design-System). - -This library currently supports **desktop** and **Android** targets, in the next versions it will -support **iOS** and **web**. - -## Installation - -In the module **build.gradle.kts**: - -```kotlin -dependencies { - implementation("org.hisp.dhis.mobile:designsystem:0.3.0") -} -``` - -# Usage - -```kotlin -setContent { - DHIS2Theme { - // A surface container using the 'background' color from the theme - Surface( - modifier = Modifier.fillMaxSize(), - color = SurfaceColor.Container - ) { - Components() - } - } -} -``` - -```kotlin -Button( - text = provideStringResource("show_more"), - icon = { - Icon( - painter = provideDHIS2Icon(resourceName = "dhis2_blood_a_n_positive"), - contentDescription = "" - ) - }, - style = ButtonStyle.KEYBOARDKEY -) {} -``` +Dhis2 Mobile UI library documentation, installation and usage is explained in [DHIS2 Developer portal](https://developers.dhis2.org/mobile/mobile-ui/overview) ## Compose Compiler Reports