Skip to content

Commit

Permalink
Update README with new search URL examples, MyBanjirBot & changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
zulhfreelancer committed Jan 1, 2017
1 parent 76e0a13 commit c231a22
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit c231a22

Please sign in to comment.