Skip to content

Commit 18f821b

Browse files
committed
Add overview section in README
1 parent 14e7248 commit 18f821b

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Data Wilayah Indonesia API
1+
# API Wilayah Indonesia
22

33
[![Node.js](https://img.shields.io/badge/Node.js-v14%2B-brightgreen)](https://nodejs.org/)
44
[![Express](https://img.shields.io/badge/Express.js-4.x-blue)](https://expressjs.com/)
@@ -10,18 +10,26 @@
1010
[![GitHub forks](https://img.shields.io/github/forks/IrvanFza/api-wilayah.svg)](https://github.com/IrvanFza/api-wilayah/network/members)
1111
[![GitHub stars](https://img.shields.io/github/stars/IrvanFza/api-wilayah.svg)](https://github.com/IrvanFza/api-wilayah/stargazers)
1212

13-
This project provides a comprehensive RESTful API for detailed Indonesian administrative regions and demographic information. The data is sourced from the Ministry of Home Affairs of Indonesia (Kemendagri) and is regularly updated using automated data scraping.
13+
## Overview
14+
Another Wilayah API in Indonesia! But what makes this API project different?
15+
- **Regular Data Update**: This project utilize GitHub Actions to regularly scrape data (once in a week) from Kemendagri.
16+
- **Data Availability**: This project is hosted on GitHub Pages so you don't have to worry about the availability (but you might worry about the scalability, see more in the [GitHub Pages Bandwidth Restrictions](#github-pages-bandwidth-restrictions) section)
17+
- **Population and Demography**: This API includes population and demography data that you may want to use!
18+
- **Open Source!**: This project is open source! Any contributions are welcome, and of course you may serve this API in your own server!
1419

1520
Here are some quick links to example endpoints for accessing the data:
1621

17-
- **Provinsi**: https://irvanfza.github.io/api-wilayah/api/provinsi.json
18-
- **Kabupaten/Kota**: https://irvanfza.github.io/api-wilayah/api/kabupaten_kota/11.json
19-
- **Kecamatan**: https://irvanfza.github.io/api-wilayah/api/kecamatan/11.01.json
20-
- **Desa/Kelurahan**: https://irvanfza.github.io/api-wilayah/api/desa_kelurahan/11.01.01.json
22+
- **Provinsi**: <a href="https://irvanfza.github.io/api-wilayah/api/provinsi.json" target="_blank">https://irvanfza.github.io/api-wilayah/api/provinsi.json</a>
23+
- **Kabupaten/Kota**: <a href="https://irvanfza.github.io/api-wilayah/api/kabupaten_kota/11.json" target="_blank">https://irvanfza.github.io/api-wilayah/api/kabupaten_kota/11.json</a>
24+
- **Kecamatan**: <a href="https://irvanfza.github.io/api-wilayah/api/kecamatan/11.01.json" target="_blank">https://irvanfza.github.io/api-wilayah/api/kecamatan/11.01.json</a>
25+
- **Desa/Kelurahan**: <a href="https://irvanfza.github.io/api-wilayah/api/desa_kelurahan/11.01.01.json" target="_blank">https://irvanfza.github.io/api-wilayah/api/desa_kelurahan/11.01.01.json</a>
26+
27+
> **Data Source**: The data provided by this API is obtained from the official Indonesian government repository at <a href="https://katalog.satudata.go.id/organization/kementerian-dalam-negeri" target="_blank">https://katalog.satudata.go.id/organization/kementerian-dalam-negeri</a>. While every effort has been made to ensure the accuracy and reliability of the data, it is provided on an "AS IS" basis without any warranties—either express or implied—regarding its completeness or suitability for any particular purpose. By using this API, you agree to verify and adhere to the data usage terms of the original source.
2128
2229
## Table of Contents
2330

24-
- [Data Wilayah Indonesia API](#data-wilayah-indonesia-api)
31+
- [API Wilayah Indonesia](#api-wilayah-indonesia)
32+
- [Overview](#overview)
2533
- [Table of Contents](#table-of-contents)
2634
- [Introduction](#introduction)
2735
- [Features](#features)

0 commit comments

Comments
 (0)