Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BadKiko authored Aug 30, 2023
1 parent a048358 commit c4ac20e
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Kige
## What is Kige?
Kiger - is an image-picker for android written for Jetpack Compose. Its give you ability to choose image from your gallery. It uses Modal Bottom Sheet State which added in Jetpack Compose Material 3 1.2.0-alpha02

Project in develop!

Maded with ♥ by Kiko

![Kotlin](https://img.shields.io/badge/kotlin-%237F52FF.svg?style=for-the-badge&logo=kotlin&logoColor=white)
![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)

## Implementation
First of all, you need to add jitpack repo (in project settings.gradle)

> For Groovy:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```

> For Kotlin DSL:
```
repositories {
...
maven(url="https://jitpack.io")
}
```

And add library in build.gradle dependency

[![](https://jitpack.io/v/BadKiko/kige.svg)](https://jitpack.io/#BadKiko/kige)

> For Groovy:
```
implementation 'com.github.BadKiko:kige:version'
```

> For Kotlin DSL:
```
implementation("com.github.BadKiko:kige:version")
```

## Usage

For get imagee-picker you can execute in @Composable function:

```
KigePicker { image ->
...
}
```

0 comments on commit c4ac20e

Please sign in to comment.