Skip to content

Commit 7cd7780

Browse files
authored
docs: update introduction position as in design
1 parent 6a797f7 commit 7cd7780

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# OUDS Android
22

3-
## Getting started
3+
The OUDS Android library is compatible with **Android 5.0 (API level 21) and higher**. It serves as the interface between applications and custom themes, providing essential components for app development.
44

5-
The OUDS Android library is compatible with **Android 5.0 (API level 21) and higher**.
5+
## Getting started
66

77
### Gradle
88

@@ -19,6 +19,7 @@ dependencies {
1919
// ...
2020
}
2121
```
22+
2223
</details></br>
2324

2425
<details>
@@ -32,11 +33,12 @@ dependencies {
3233
// ...
3334
}
3435
```
36+
3537
</details>
3638

3739
### Themes
3840

39-
The `OudsTheme` method is an extension of the `MaterialTheme` method which allows to use the Orange Unified Design System in Jetpack Compose applications. Because OUDS Android supports multi-theme, you must provide the theme to use in your application as a parameter. OUDS Android components such as `OudsButton` and `OudsCheckbox` as well as Material components use values provided by the theme when they are rendered on screen. For instance if you want to use the Orange theme:
41+
The `OudsTheme` method is an extension of the `MaterialTheme` method which allows to use the Orange Unified Design System in Jetpack Compose applications. Because OUDS Android supports multi-theme, you must provide the theme to use in your application as a parameter. OUDS Android components such as `OudsButton` and `OudsCheckbox` as well as Material components use values provided by the theme when they are rendered on screen. For instance if you want to use the Orange theme:
4042

4143
```kotlin
4244
OudsTheme(themeContract = OrangeTheme()) {
@@ -86,4 +88,4 @@ OudsThemeTweak(tweak = OudsTheme.Tweak.ForceDark) {
8688

8789
### Customizing themes
8890

89-
If you want to use a custom theme, you can create your own `OudsThemeContract` implementation or extend `OrangeTheme` to create a customized theme close to that of Orange.
91+
If you want to use a custom theme, you can create your own `OudsThemeContract` implementation or extend `OrangeTheme` to create a customized theme close to that of Orange.

0 commit comments

Comments
 (0)