Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
onseok authored Dec 11, 2023
1 parent ea60c6c commit 9c727ae
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,16 @@

### Compose Multiplatform

`peekaboo` is based on `Compose Multiplatform`, currently targeting only `iOS` and `Android`.
Please note that it primarily focuses on these platforms, and additional platforms may be considered in the future.
When using `peekaboo` on Android, ensure that Google's Jetpack Compose version is compatible with Peekaboo's Compose Multiplatform version.
Presently, the only available artifact is `peekaboo-image-picker`, but the intention is to gradually expand the range of features and artifacts over time.
`peekaboo` is based on `Compose Multiplatform`, currently targeting only `iOS` and `Android`. <br/>
Please note that it primarily focuses on these platforms, and additional platforms may be considered in the future. <br/>
When using `peekaboo` on Android, ensure that Google's Jetpack Compose version is compatible with `peekaboo`'s Compose Multiplatform version. <br/>

## Installation

The minimum supported Android SDK is 24 (Android 7.0).

In your `commonMain` configuration, add `peekaboo` as a dependency to your project. It's available on Maven Central.

In your `commonMain` configuration, add `peekaboo` as a dependency to your project. It's available on Maven Central.
<br/>
### Without Version Catalog

```kotlin
Expand Down Expand Up @@ -63,6 +62,8 @@ commonMain {
| `peekaboo-image-picker` | Simplifies the process of selecting single or multiple images in `iOS` and `Android` apps. |
| `peekaboo-camera-picker` | 🚧 Coming soon! A convenient way to capture and select images directly from cameras on iOS and Android. 📸 |

<br/>

## Usage
### Select Single Image

Expand Down Expand Up @@ -95,6 +96,8 @@ Button(

Simply select the desired image with an intuitive interface.

<br/>

### Select Multiple Images

If you want to select multiple images, you can use `SelectionMode.Multiple()`. And you can set the maximum number of images to select.
Expand Down Expand Up @@ -129,22 +132,30 @@ Button(
|-----------------------------------------------------------------|---------------------------------------------------------|
| <img src="https://github.com/TEAM-PREAT/peekaboo/assets/76798309/e26ae1b3-4333-41a9-92c3-ebe56c337d79" width="300" height="700"> | <img src="https://github.com/TEAM-PREAT/peekaboo/assets/76798309/a990ce09-d485-4a0f-9416-8af8b040cf2d" width="300" height="700"> |

<br/>

## ByteArray to ImageBitmap Conversion
We've added a new extension function `toImageBitmap()` to convert a `ByteArray` into an `ImageBitmap`.
We've added a new extension function `toImageBitmap()` to convert a `ByteArray` into an `ImageBitmap`. <br/>
This function simplifies the process of converting image data into a displayable format, enhancing the app's capability to handle image processing efficiently.

### Usage
```kotlin
val imageBitmap = byteArray.toImageBitmap()
```

## Contributions
<br/>

Contributions are always welcome. 🙏
## Contributions 🙏

Contributions are always welcome!

If you'd like to contribute, please feel free to create a PR or open an issue. 👍

<br/>

## Stargazers :star:
Support it by joining __[stargazers](https://github.com/TEAM-PREAT/peekaboo/stargazers)__ for this repository. :star: <br>

## License

```
Expand Down

0 comments on commit 9c727ae

Please sign in to comment.