diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ebf1c3 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# flood_relief + +[![Status: Active](https://img.shields.io/badge/status-active-green.svg)](https://github.com/ceadoor/flood_relief/commits/master) +[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/ceadoor/flood_relief/) +[![Twitter](https://img.shields.io/twitter/url/https/github.com/ceadoor/flood_relief/.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Din.keralafloodrelief&text=Install%20this%20app%20to%20track%20and%20locate%20the%20flood%20stranded) + +**An Android App**, designed and developed to help the ***stranded people of the flood and rain*** in **Kerala**, focussing on *seeking help* from the **local support** for finding and rescuing the survivors of the disaster **in all the flood affected district areas**. + +[Download from Google Play](https://play.google.com/store/apps/details?id=in.keralafloodrelief) + +App collects and fetches the **user's geo location, tags it with the message from the user, rates the need and level of support needed +and shares with the local rescue and support crew who are geographically nearer to the stranded ones.** + +![image](https://i.imgur.com/mtlzBwj.png) + +Done with the aim to help ones in danger or similar situation as soon as possible *by people who are close to them* if there's a tiny chance that official authorities can't make in time. + +App adds the **user's response to the request** which could make the rescuer(s) prepare for what's needed. + +App is designed in a way that **shows the closest stranded peoples' request on the top** and the others' followed by it. + +### #HelpKeralaSaveKerala + +## Specs / Open-source libraries: +- [http-request](https://github.com/kevinsawicki/http-request) by [kevinsawicki](https://github.com/kevinsawicki) +- [picasso image loader](https://github.com/square/picasso) by [square](https://github.com/square) + +## Branches + +Source for [backend](https://github.com/ceadoor/flood_relief/tree/backend) + +## Contributing + +Try +- adding a status report to each request +- adding a Share Button for each request page for message forwarding + +Please **contribute** to the project either by [_creating a PR_](https://github.com/ceadoor/flood_relief/compare) or [_submitting an issue_](https://github.com/ceadoor/flood_relief/issues/new) on GitHub.