Skip to content

Commit 4cfd908

Browse files
authored
Update README.md
1 parent 557c48e commit 4cfd908

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
<div align="center">
2-
<img src="https://user-images.githubusercontent.com/37406965/51083189-d5dc3a80-173b-11e9-8ca0-28015e0893ac.png" alt="Mifos Mobile" />
2+
<img src="https://user-images.githubusercontent.com/37406965/51083189-d5dc3a80-173b-11e9-8ca0-28015e0893ac.png" alt="Android Client" />
33

44
# Android-Client Android Application for MifosX
55

6-
This is an Android Application built on top of the [MifosX](https://mifosforge.jira.com/wiki/spaces/MIFOSX/overview) platform and written in Kotlin. It is based on Mifos X - a robust core banking platform that is developed for field officers using which they process transactions, keep track of their client’s data, center records, group details, different types of accounts (loan, savings and recurring) of the client, run reports of clients, etc. Its sole purpose is to make field operations easier and effortless. This application also provides an offline feature that allows officers to connect with clients and provide them financial support in remote areas as well.
6+
This Android application is built on the powerful [MifosX](https://mifosforge.jira.com/wiki/spaces/MIFOSX/overview) platform and written in Kotlin. MifosX is a comprehensive core banking platform designed for field officers to efficiently process transactions, manage client data, track center records, group details, and handle various types of accounts such as loans, savings, and recurring accounts. The application's primary goal is to streamline field operations, making them easier and more efficient.
7+
8+
One of the standout features of this application is its offline capability, allowing officers to connect with clients and provide financial support even in remote areas. This ensures that clients in underserved areas can still access the financial services they need.
79

810
![Kotlin](https://img.shields.io/badge/kotlin-%237F52FF.svg?style=flat-square&logo=kotlin&logoColor=white)
911
![Kotlin Multiplatform](https://img.shields.io/badge/Kotlin%20Multiplatform-4c8d3f?style=flat-square&logo=kotlin&logoColor=white)
@@ -14,7 +16,7 @@ This is an Android Application built on top of the [MifosX](https://mifosforge.j
1416
[![Release](https://img.shields.io/github/v/release/openMF/android-client)](https://github.com/openMF/android-client/releases)
1517

1618

17-
[![Workflow for master/development branches](https://github.com/openMF/android-client/actions/workflows/pr-check-android.yml/badge.svg)](https://github.com/openMF/android-client/actions/workflows/pr-check-android.yml)
19+
[![PR Checks](https://github.com/openMF/android-client/actions/workflows/pr-check-android.yml/badge.svg)](https://github.com/openMF/android-client/actions/workflows/pr-check-android.yml)
1820
[![Slack](https://img.shields.io/badge/Slack-4A154B?style=flat-square&logo=slack&logoColor=white)](https://join.slack.com/t/mifos/shared_invite/zt-2wvi9t82t-DuSBdqdQVOY9fsqsLjkKPA)
1921
[![Jira](https://img.shields.io/badge/jira-%230A0FFF.svg?style=flat-square&logo=jira&logoColor=white)](https://mifosforge.jira.com/jira/software/c/projects/MIFOSAC/issues/?filter=allissues&jql=project%20%3D%20%22MM%22%20ORDER%20BY%20created%20DESC)
2022
</div>
@@ -28,42 +30,42 @@ This is an Android Application built on top of the [MifosX](https://mifosforge.j
2830
- **Username**: `mifos`
2931
- **Password**: `password`
3032

31-
### How to Contribute
33+
## How to Contribute
3234
Thank you for your interest in contributing to the Mifos Mobile project by Mifos! We welcome all contributions and encourage you to follow these guidelines to ensure a smooth and efficient collaboration process.
3335
To get started, please refer to the [Contribution Guide](https://github.com/openMF/android-client/wiki/Contribution-Guide) for detailed instructions on how to contribute to the project.
3436

35-
### Branch Policy
37+
## Branch Policy
3638
For development purposes, always pull from the **development** branch, as all contributions and updates are merged into this branch. Upon completion of development, changes are subsequently merged into the **master** branch, which represents the stable and bug-free version of the code
3739

38-
### Development Setup
40+
## Development Setup
3941
Please refer to the [Development Setup Guide](https://github.com/openMF/android-client/wiki/Set-up-an-environment) for detailed instructions on configuring the development environment.
4042

41-
### Committing Your Changes
43+
## Committing Your Changes
4244
After making changes in your local repository, you will need to commit them to your GitHub repository.
4345
If you are unfamiliar with the process of committing changes, please refer to the [Committing Your Changes](https://github.com/openMF/android-client/wiki/Committing-Your-Changes) guide.
4446

45-
### Squashing Your Commits
47+
## Squashing Your Commits
4648
To ensure a clean and organized Git history, contributors are encouraged to squash their commits before merging. Instructions on how to squash commits can be found in the [Squashing Your Commits](https://github.com/openMF/android-client/wiki/Squashing-Your-Commits) guide.
4749

48-
### Resolving Merge Conflicts
50+
## Resolving Merge Conflicts
4951
Occasionally, merge conflicts may arise when your pull request is being reviewed. These conflicts need to be resolved manually.
5052
To learn how to resolve merge conflicts, please refer to the [Solving Merge Conflicts](https://github.com/openMF/android-client/wiki/Solving-Merge-Conflicts) guide
5153

5254
## Code of Conduct
5355
Mifos has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
5456

57+
## Wiki
58+
59+
Please visit our [Wiki](https://github.com/openMF/android-client/wiki) page for a detailed overview of the project's architecture and guidelines. Explore further to gain a deeper understanding of our project.
60+
61+
## License
62+
63+
This project is licensed under the open source [MPL V2](https://github.com/openMF/android-client/blob/master/LICENSE.md).
64+
5565
## Contributors
5666

5767
Special thanks to the incredible code contributors who continue to drive this project forward.
5868

5969
<a href="https://github.com/openMF/android-client/graphs/contributors">
6070
<img src="https://contrib.rocks/image?repo=openMF/android-client" />
6171
</a>
62-
63-
## Wiki
64-
65-
View [Wiki](https://github.com/openMF/android-client/wiki)
66-
67-
## License
68-
69-
This project is licensed under the open source [MPL V2](https://github.com/openMF/android-client/blob/master/LICENSE.md).

0 commit comments

Comments
 (0)