Skip to content
This repository was archived by the owner on Apr 29, 2025. It is now read-only.

Commit 4111344

Browse files
authored
Update README.md
1 parent 915fdcb commit 4111344

1 file changed

Lines changed: 28 additions & 3 deletions

File tree

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# Mobile-Passcode
1+
# Mifos-Passcode
22
Library for passcode implementation along with an optional additional feature to ask for passcode when your app resumes from background. (Works with minSDK >= 21)
33

4+
# Project Structure :
5+
6+
- **`androidApp` Module**:
7+
- Contains the Android-specific application code.
8+
- Depends on the `shared` module to utilize common code across platforms.
9+
10+
- **`iosApp` Module**:
11+
- Holds the iOS-specific application code.
12+
- Integrates the `shared` module, typically as a framework, to access shared logic.
13+
14+
- **`shared` Module**:
15+
- The core module containing platform-agnostic code, including business logic and Compose Multiplatform UI components.
16+
- Referenced by both `androidApp` and `iosApp` modules to promote code reuse.
17+
18+
- **`cmp-mifos-passcode` Module**:
19+
- A specialized module designed to package and publish the `shared` module as a Compose Multiplatform (CMP) library.
20+
- Facilitates the distribution and reuse of the shared codebase across different projects or teams.
21+
22+
423
Usage
524
-----
625

@@ -27,7 +46,13 @@ dependencies {
2746

2847
## Example
2948

30-
https://github.com/openMF/mifos-passcode/assets/90026952/ee9e9610-fdb6-49d3-b485-9eb9cd78fb9f
49+
## Android Implementation:
50+
51+
https://github.com/user-attachments/assets/a93781d1-13b6-4c48-a2c1-2021ca56fd0b
52+
53+
## IOS Implementation :
54+
55+
https://github.com/user-attachments/assets/9267d7ad-1e95-4212-8f5b-4516413e8b5d
3156

3257
For a basic implementation of the PassCode Screen
3358
- Inject the `PasscodeRepository` in your activity which is essentially abstracting the operations related to saving, retrieving, and validating the passcode
@@ -67,4 +92,4 @@ For a basic implementation of the PassCode Screen
6792
<td><img src="https://github.com/openMF/mifos-passcode/assets/90026952/e01c0357-9bd2-4472-b2c1-3826be89cd8c" width=250 height=510></td>
6893
<td><img src="https://github.com/openMF/mifos-passcode/assets/90026952/377d83da-1956-45c6-96c1-7befbf545264" width=250 height=510></td>
6994
</tr>
70-
</table>
95+
</table>

0 commit comments

Comments
 (0)