Skip to content

Commit

Permalink
best usage added.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmobin789 authored Nov 11, 2020
1 parent 62509ce commit 4dc2134
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

:camera:

A reactive android custom gallery which allows to set and do limited or unlimited multi-selection on pictures and retrieve selections. Its based on MVVM clean architecture and supports pagination based on page size.
It also returns the selected pictures for your tasks. It uses Android Database Cursor API to query images from device storage asynchronously using RxJava and returns them based on provided page size value when its scrolled.
An Rx/Flow gallery which allows to set and do limited or unlimited multi-selection on pictures and retrieve selections. Its based on MVVM clean architecture and supports pagination based on page size.
It also returns the selected pictures for your tasks. It uses Android Database Cursor API to query images from device storage asynchronously using RxJava or Kotlin Flow API and returns them based on provided page size value when its scrolled.
It also provides open to implement delete option to permanently remove pictures from gallery.
It can be used with in your app or as a foundation for your own android library.

Expand All @@ -17,9 +17,31 @@ It can be used with in your app or as a foundation for your own android library.
- Modifications/Enhancements can be made as required.
- Highly decoupled,optimized and clean code.
- No Obfuscation Required (Proguard/Dexguard).
- Powered by RxJava.
- Available for both Rx and Kotlin Flow API.
- **It would be a part of your project while not implying any 3rd-party involvement.**



## Best Practice

This project includes below 2 modules which contain seperate implementations for custom gallery based on RxJava and Kotlin Flow API use one at a time.

**Tip:**
If you are a newbie choose the **app-flow** module as its Kotlin latest based on built-in Flow API else if your app uses rx-java then choose **app-rx** module.

**app-rx** module uses reactive approach with loading images.

**app-flow** module uses Kotlin Flow API's approach with loading images.

**For single module project:**

Copy the gallery package to it.

**For multi-module project:**

Add this module to your code as an AAR or complete library module then use it as dependency in app modules.


### How to use ?

Just clone the project in Android Studio and run it.
Expand Down

0 comments on commit 4dc2134

Please sign in to comment.