From c231a22a357ed34c11deb0646dcc7a957987ba8c Mon Sep 17 00:00:00 2001 From: Zulhilmi Zainudin Date: Sun, 1 Jan 2017 22:03:24 +0000 Subject: [PATCH] Update README with new search URL examples, MyBanjirBot & changelog --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee59d3c..2575b4d 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,32 @@ Malaysia flood JSON API. Data from [JKR Malaysia](http://bencanaalam.jkr.gov.my/v2/). +### Endpoint + [https://banjir-api.herokuapp.com/api/v1/reports.json](https://banjir-api.herokuapp.com/api/v1/reports.json) +### Querying + +1. `/reports.json?daerah=EXAMPLE&negeri=EXAMPLE` +2. `/reports.json?daerah=EXAMPLE` +3. `/reports.json?negeri=EXAMPLE` + +**Example** + +1. [https://banjir-api.herokuapp.com/api/v1/reports.json?daerah=setiu&negeri=terengganu](https://banjir-api.herokuapp.com/api/v1/reports.json?daerah=setiu&negeri=terengganu) +2. [https://banjir-api.herokuapp.com/api/v1/reports.json?daerah=setiu](https://banjir-api.herokuapp.com/api/v1/reports.json?daerah=setiu) +3. [https://banjir-api.herokuapp.com/api/v1/reports.json?negeri=terengganu](https://banjir-api.herokuapp.com/api/v1/reports.json?negeri=terengganu) + ### About -1. Built with Ruby on Rails 5.0.1 +1. Built with Ruby (2.4.0) on Rails (5.0.1) 2. Deployed on Heroku on midnight of 01 Jan 2017 3. Data updated every 1 hour +### Built With Banjir API + +- [MyBanjir Telegram Bot](https://telegram.me/MyBanjirBot) + ### Known Issues - The `null` values are originated from empty values from the source (JKR) site @@ -22,6 +40,13 @@ Malaysia flood JSON API. Data from [JKR Malaysia](http://bencanaalam.jkr.gov.my/ - Special route for `/negeri.json` - Special route for `/negeri/daerah.json` +### Changelog + +**v1.1.0 - 02/01/2017** + +- Add `latitude`, `longitude` and `google_maps_url` in each object +- Add search by `daerah` and/or `negeri` query string feature + ### Contribute Feel free to fork this project and improve it. Submit your Pull Request for merge review.