Skip to content

Commit b2b8a8a

Browse files
committed
docs: update readme according latest endpoints
1 parent d426b1f commit b2b8a8a

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

README.id.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,17 +58,20 @@ _Server_ RESTful API gratis yang menyajikan Doa dan Dzikir sesuai Sunnah Nabi Mu
5858
Cara cepat untuk menggunakannya secara pribadi dengan PaaS yang ada
5959

6060
[![Deploy dengan Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffitrahive%2Fdua-dhikr%2Ftree%2Fmain)
61-
[![Deploy dengan Cyclic](https://ik.imagekit.io/sooluh/cyclic.svg)](https://app.cyclic.sh/#/join/sooluh)
6261

6362
## Penggunaan
6463

6564
URL Utama : [`http://localhost:3000`](https://dua-dhikr.vercel.app)
6665

67-
| Titik Akhir | Deskripsi | Metode |
68-
| --------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------- |
69-
| [`/:lang`](https://dua-dhikr.vercel.app/id) | Mendapatkan daftar dengan bahasa spesifik | `*GET*` |
70-
| [`/:lang/:category`](https://dua-dhikr.vercel.app/id/daily-dua) | Mendapatkan daftar isi berdasarkan bahasa dan kategori | `*GET*` |
71-
| [`/:lang/:category/:id`](https://dua-dhikr.vercel.app/id/daily-dua/1) | Mengambil detail Doa & Dzikir berdasarkan bahasa, kategori dan ID spesifik | `*GET*` |
66+
| Titik Akhir | Deskripsi | Metode |
67+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------- | ------- |
68+
| [`/languages`](https://dua-dhikr.vercel.app/languages) | Mendapatkan daftar bahasa yang di dukung | _`GET`_ |
69+
| [`/categories`](https://dua-dhikr.vercel.app/categories) | Mendapatkan daftar kategori doa & dzikir | _`GET`_ |
70+
| [`/categories/:slug`](https://dua-dhikr.vercel.app/categories/daily-dua) | Mendapatkan daftar doa & dzikir berdasarkan kategori tertentu | _`GET`_ |
71+
| [`/categories/:slug/:id`](https://dua-dhikr.vercel.app/categories/daily-dua/1) | Mendapatkan detail doa & dzikir berdasarkan kategori dan id | _`GET`_ |
72+
73+
> [!IMPORTANT]
74+
> Untuk mendapatkan data dengan bahasa yang didukung, gunakan header `Accept-Language`. Secara bawaan akan menggunakan `id` (Bahasa Indonesia).
7275

7376
### Pameran
7477

@@ -86,16 +89,16 @@ Daftar _server_ API yang siap digunakan secara publik
8689

8790
Lengkapi atau tambah data Doa & Dzikir sesuai Sunnah yang kamu tahu, pastikan data tersebut shahih!
8891

89-
> **Warning**<br>
92+
> [!WARNING]
9093
> Bertakwalah kepada Allah! Kontribusimu akan dihisab kelak di akhirat!
9194

9295
1. _Fork_ repositori ini
93-
2. Buka `data/` dan pilih bahasa yang sudah ada (atau tambahkan baru), gunakan kode `ISO 639`
94-
3. Buka berkas JSON di kategori yang diinginkan
96+
2. Buka `data/dua-dhikr` dan pilih kategori yang tersedia
97+
3. Buka berkas JSON pada bahasa yang diinginkan, atau tambah baru dengan kode `ISO 639`
9598
4. Lakukan perubahan dengan hati-hati!
9699
5. _Commit_ perubahan dengan perintah `yarn commit`.
97100
6. Ajukan _pull-request_
98-
7. Tunggu _owner_ melakukan _merge_
101+
7. Tunggu kami melakukan _merge_
99102

100103
### Catatan
101104

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,17 +58,20 @@ A free RESTful API server that provides Duas and Dhikr following the Sunnah of t
5858
The fastest way to use it privately on PaaS available
5959

6060
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffitrahive%2Fdua-dhikr%2Ftree%2Fmain)
61-
[![Deploy with Cyclic](https://ik.imagekit.io/sooluh/cyclic.svg)](https://app.cyclic.sh/#/join/sooluh)
6261

6362
## Basic Usage
6463

6564
Base URL : [`http://localhost:3000`](https://dua-dhikr.vercel.app)
6665

67-
| Endpoint | Description | Method |
68-
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------ |
69-
| [`/:lang`](https://dua-dhikr.vercel.app/id) | Obtaining a list of Duas & Dhikr in a specific language | `GET` |
70-
| [`/:lang/:category`](https://dua-dhikr.vercel.app/id/daily-dua) | Getting a table of contents based on language and category | `GET` |
71-
| [`/:lang/:category/:id`](https://dua-dhikr.vercel.app/id/daily-dua/1) | Retrieving details of a Dua/Dhikr based on language, category, and specific ID | `GET` |
66+
| Endpoint | Description | Method |
67+
| ------------------------------------------------------------------------------ | ---------------------------------------------------------- | ------ |
68+
| [`/languages`](https://dua-dhikr.vercel.app/languages) | Retrieve a list of supported languages | `GET` |
69+
| [`/categories`](https://dua-dhikr.vercel.app/categories) | Retrieve a list of dua & dhikr categories | `GET` |
70+
| [`/categories/:slug`](https://dua-dhikr.vercel.app/categories/daily-dua) | Retrieve a list of dua & dhikr based on a category | `GET` |
71+
| [`/categories/:slug/:id`](https://dua-dhikr.vercel.app/categories/daily-dua/1) | Retrieve details of a dua & dhikr based on category and id | `GET` |
72+
73+
> [!IMPORTANT]
74+
> To retrieve data in supported language, use the `Accept-Language` header. By default, it will use `id` (Indonesian).
7275

7376
### Showcase
7477

@@ -86,16 +89,16 @@ List of server APIs ready to use publicly
8689

8790
Complete or add Duas and Dhikr data according to the authentic Sunnah that you know, ensure the data is authentic!
8891

89-
> **Warning**<br>
92+
> [!WARNING]
9093
> Fear Allah! Your contributions will be accounted for in the Hereafter!
9194

9295
1. Fork this repository
93-
2. Go to the `data/` and navigate to the existing language (or add one), use `ISO 639` code
94-
3. Open the JSON file in the desired category
95-
4. Make change carefully!
96+
2. Open `data/dua-dhikr` and select an available category
97+
3. Open the JSON file in the desired language, or add a new one with the `ISO 639` code
98+
4. Make changes carefully!
9699
5. Commit the change using the command `yarn commit`.
97-
6. Create a pull-request
98-
7. Wait for the owner to merge
100+
6. Submit a pull-request
101+
7. Wait for us to perform the merge
99102

100103
### Note
101104

0 commit comments

Comments
 (0)