Skip to content

Commit 50e64e3

Browse files
committed
chore(feature:autopay): update module structure in README.md
1 parent 7539965 commit 50e64e3

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

feature/autopay/README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The AutoPay feature module provides functionality for setting up and managing au
99
- Manage automatic payment preferences
1010
- View payment history and status
1111
- Enable/disable automatic payments
12+
- Quick access from Send Money Options screen
13+
- Integration with Home screen for easy access
1214

1315
## Screenshots
1416
### Android
@@ -30,14 +32,31 @@ feature/autopay/
3032
│ │ │ │ └── AutoPayModule.kt
3133
│ │ │ ├── AutoPayScreen.kt
3234
│ │ │ ├── AutoPayNavigation.kt
33-
│ │ │ └── AutoPayViewModel.kt
35+
│ │ │ ├── AutoPayViewModel.kt
36+
│ │ │ ├── AutoPaySetupScreen.kt
37+
│ │ │ ├── AutoPayRulesScreen.kt
38+
│ │ │ ├── AutoPayPreferencesScreen.kt
39+
│ │ │ └── AutoPayHistoryScreen.kt
3440
│ │ └── composeResources/
3541
│ └── androidMain/
3642
│ └── kotlin/org/mifospay/feature/autopay/
3743
├── build.gradle.kts
3844
└── README.md
3945
```
4046

47+
## Integration Points
48+
49+
### Send Money Options Integration
50+
- AutoPay button added to SendMoneyOptionsScreen
51+
- Uses `MifosIcons.CalenderMonth` icon for recurring payment context
52+
- Positioned below the main payment options row
53+
- Navigates to AutoPay dashboard when clicked
54+
55+
### Home Screen Integration
56+
- AutoPay button available on the main home screen
57+
- Uses `MifosIcons.Payment` icon for general payment context
58+
- Provides quick access to AutoPay functionality
59+
4160
## Dependencies
4261
- Compose UI components
4362
- Material3 design system
@@ -47,5 +66,16 @@ feature/autopay/
4766
## Usage
4867
This module is designed to be integrated into the main application through dependency injection. The AutoPayModule provides the necessary dependencies for the AutoPay feature.
4968

69+
### Navigation
70+
The AutoPay feature can be accessed from:
71+
1. **Home Screen**: Direct access via AutoPay button
72+
2. **Send Money Options**: Via AutoPay button in the payment options grid
73+
74+
### Key Files
75+
- `AutoPayScreen.kt`: Main AutoPay dashboard screen
76+
- `AutoPayNavigation.kt`: Navigation routes and functions
77+
- `AutoPayViewModel.kt`: Business logic and state management
78+
- `AutoPayModule.kt`: Dependency injection configuration
79+
5080
## Development Status
51-
🚧 **In Development** - Basic module structure created
81+
🚧 **In Development** - Basic module structure created with navigation integration

0 commit comments

Comments
 (0)