Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LinX64 authored Apr 4, 2024
1 parent 3948d60 commit b804e6b
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# 📘 Reusable Components library for Compose

![master CI](https://github.com/LinX64/Reusable/actions/workflows/publish.yaml/badge.svg)
![develop CI](https://github.com/LinX64/Reusable/actions/workflows/ci.yaml/badge.svg)

# Reusable Components library for Compose

This library contains a set of reusable components for Jetpack Compose. Due to the nature of
Compose, these components are highly customizable and can be used in a variety of ways.
This library is a treasure trove of reusable components tailored for Jetpack Compose, designed to simplify the creation of complex interfaces. It's your go-to toolkit for crafting visually stunning UIs effortlessly. So, let's cut to the chase and unleash the magic! 😃

## Components

Expand All @@ -13,14 +12,45 @@ Currently, the library contains the following components:
- Containers
- Buttons
- Columns
- Preview
- TODO: Preview
- TODO: Spacers

## Usage

...I will add this section once it was published to Maven Central.
Using the components is very simple. Just add the library to your project and based on your need,
let's say you want to have a Scrollable screen with a few Buttons:

```kotlin
ScrollableScreen {
PrimaryButton(text = R.string.app_name, onClick = {})

Spacer(modifier = Modifier.height(16.dp))

PrimaryButton(text = R.string.app_name, onClick = {})

Spacer(modifier = Modifier.height(16.dp))

PrimaryButton(text = R.string.app_name, onClick = {})

Spacer(modifier = Modifier.height(16.dp))

PrimaryButton(text = R.string.app_name, onClick = {})
}
```

And that's it! You have a scrollable screen with a few buttons. You can customize the container by
passing your own `modifier` to it. The same goes for the buttons, you can pass your own `modifier`
to it.

This is how it will look like:

<img src="https://i.imgur.com/9AfnPTk.png" width="250" />

## Installation

...I will add this section once it is published to Maven Central.

## License

This library is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more
information.

0 comments on commit b804e6b

Please sign in to comment.