-
Notifications
You must be signed in to change notification settings - Fork 469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme Updated #1818
Readme Updated #1818
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good me, but it's gonna increase project size
for example 90 images and per images 150 kb so size would be increased by 13.5 MB which is huge,
instead of you edit your md files in this opened pr and upload imaged directly and use those link in table.
@revanthkumarJ For example, see in Android.md file i've just dragged an image and it's uploaded and provided a link and used that link in table, |
ok i will do it |
12cc3ac
to
84f1670
Compare
@niyajali check it once , i have drag and dropped images and used them in tables and deleted the previously added images folder |
@@ -2,15 +2,18 @@ | |||
|
|||
# Mobile Wallet | |||
|
|||
Mobile Wallet is an Android-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows | |||
Mobile Wallet is an Kotlin Multiplatform (KMP)-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update this line - KMP Application, not a framework
- Development and enhancements related to Kotlin Multiplatform. | ||
- Logical changes or improvements in existing Jetpack Compose-based features. | ||
|
||
We appreciate your contributions and look forward to collaborating with you! | ||
|
||
| Development | Chat | | ||
|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| | ||
| ![Mobile-Wallet CI[Master/Dev]](https://github.com/openMF/mobile-wallet/workflows/Mobile-Wallet%20CI%5BMaster/Dev%5D/badge.svg?branch=dev) | [](https://mifos.slack.com/) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update this badge with updated workflow file this is old and we don't have this workflow, and can you upload some badges like kotlin, kmp, etc to top of the file.
|
||
* **master** | ||
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch. | ||
To know more about branch policies, click [here](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy). | ||
|
||
### Demo credentials |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And move this block below to Run the project section
@@ -58,22 +61,24 @@ that can be used as a dependency in any other wallet based project. It is develo | |||
✔️: Successfully compiled | |||
❌: Not functioning, requires further attention | |||
|
|||
## Notice | |||
⚠️ **Notice:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this notice, since we've migrated whole app to KMP & CMP
|
||
Replace **`new-branch-name`** with the name of the branch you created earlier. | ||
Once you make changes in your local repository, you need to commit them to your GitHub repository. | ||
Don't know how to commit? Click [here](https://github.com/openMF/mobile-wallet/wiki/Committing-Your-Changes) to learn more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use formal words and sentences for the good impression
Issue Fix
Fixes #{Issue Number}
Jira Task: Task_Number
Description
Summary of Changes Made:
Updated README:
Created Platform-Specific Markdown Files:
Added Navigation Table:
Checklist
Please ensure the following before submitting your pull request:
AndroidStyle.xml
style template to your code in Android Studio../gradlew check
to make sure you didn't break anything.