Skip to content

Commit

Permalink
Update README: add screenshots and project related information
Browse files Browse the repository at this point in the history
  • Loading branch information
linroid committed Apr 2, 2024
1 parent c250b75 commit a3c082f
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
@@ -1,4 +1,36 @@
# Compose Multiplatform Application
# Pexels

## Supported Platforms

| Platform | Supported | Screenshot | Link |
|--------------------------------|-----------|----------------------------------------------------|---------|
| Desktop(Linux, Windows, macOS) || <img src="./screenshots/desktop.png" width="150"/> | |
| Web || <img src="./screenshots/web.png" width="150"/> | |
| iOS || <img src="./screenshots/ios.png" width="100"/> | |
| Android || <img src="./screenshots/android.png" width="100"/> | |

## Features
- Pagination
- Pull to refresh
- Adaptive UI
- Photo zoom in and zoom out
- Transition
- Cached photo list data

## Used Libraries
- [ktor](https://ktor.io/): A multiplatform asynchronous HTTP client, which allows you to make requests and handle responses.
- [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization): A multiplatform JSON serialization library.
- [koin](https://github.com/InsertKoinIO/koin): A pragmatic lightweight dependency injection framework for Kotlin & Kotlin Multiplatform.
- [Voyager](https://github.com/adrielcafe/voyager): A pragmatic navigation library for Compose.
- [Build Config](https://github.com/gmazzo/gradle-buildconfig-plugin): A plugin for generating BuildConstants.
- [KStore](https://github.com/xxfast/KStore): A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk.
- [Napier](https://github.com/AAkira/Napier): A logger library for Kotlin Multiplatform.
- [coil](https://github.com/coil-kt/coil): Image loading for Compose Multiplatform.

## Unit Tests
[![Test](https://github.com/linroid/Pexels/actions/workflows/test.yml/badge.svg)](https://github.com/linroid/Pexels/actions/workflows/test.yml)
- `PexelsApiTest`
- `ObjectStoreTest`

## Before running!
- check your system with [KDoctor](https://github.com/Kotlin/kdoctor)
Expand Down
Binary file added screenshots/android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/ios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3c082f

Please sign in to comment.