Skip to content

Commit 5fefb53

Browse files
Update README.md
1 parent 2ca5486 commit 5fefb53

1 file changed

Lines changed: 31 additions & 8 deletions

File tree

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,28 @@ Designed with modularity and security in mind, this library is a foundational pa
3838
---
3939

4040
## Project Structure
41-
42-
### `mifos-passcode-cmp`
43-
44-
Core library module containing shared and platform-specific implementations:
45-
41+
```
42+
mifos-authenticator
43+
-core
44+
-designSystem
45+
-mifos-authenticator-passcode
46+
-commonMain
47+
-mifos-authenticator-biometrics
48+
-androidMain
49+
-commonMain
50+
-desktopMain(jvm)
51+
-windows
52+
-linux
53+
-mac
54+
-jsMain
55+
-wasmJsMain
56+
```
57+
### `core`
58+
- **`designsystem`**
59+
- It provides the foundation for theming.
60+
### `mifos-authenticator-biometrics`
4661
- **`commonMain/`**
47-
- Platform-agnostic Platform Authenticator logic and whole passcode logic.
62+
- Platform-agnostic Platform Authenticator logic.
4863
- `androidMain/`
4964
- Biometric Prompt implementation for Platform Authenticator.
5065
- `iosMain/`
@@ -53,12 +68,20 @@ Core library module containing shared and platform-specific implementations:
5368
- `windows/`
5469
- Windows Hello implementation for Platform Authenticator.
5570
- `linux/`
56-
- LocalAuthenticator implementation for Platform Authenticator.
57-
- `macOS/`
71+
72+
- `macOS/`
73+
- LocalAuthenticator implementation for Platform Authenticator.
5874
- `jsMain/`
5975
- WebAuthN implementation for using the available FIDO2 or Platform Authenticator.
6076
- `wasmMain/`
6177
- WebAuthN implementation for using the available FIDO2 or Platform Authenticator.
78+
### `mifos-authenticator-passcode`
79+
This module provides logic for pass-code authentication and the pass-code screen.
80+
81+
- **`commonMain/`**
82+
- Contains working logic for passcode authentication.
83+
- Defines the passcode screen ui and its components.
84+
6285

6386
### `sample`
6487

0 commit comments

Comments
 (0)