docs: update readme according latest endpoints

fitrahive · Aug 12, 2023 · b2b8a8a · b2b8a8a
1 parent d426b1f
commit b2b8a8a
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 22 deletions.
diff --git a/README.id.md b/README.id.md
@@ -58,17 +58,20 @@ _Server_ RESTful API gratis yang menyajikan Doa dan Dzikir sesuai Sunnah Nabi Mu
 Cara cepat untuk menggunakannya secara pribadi dengan PaaS yang ada
 
 [![Deploy dengan Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffitrahive%2Fdua-dhikr%2Ftree%2Fmain)
-[![Deploy dengan Cyclic](https://ik.imagekit.io/sooluh/cyclic.svg)](https://app.cyclic.sh/#/join/sooluh)
 
 ## Penggunaan
 
 URL Utama : [`http://localhost:3000`](https://dua-dhikr.vercel.app)
 
-| Titik Akhir                                                           | Deskripsi                                                                  | Metode  |
-| --------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------- |
-| [`/:lang`](https://dua-dhikr.vercel.app/id)                           | Mendapatkan daftar dengan bahasa spesifik                                  | `*GET*` |
-| [`/:lang/:category`](https://dua-dhikr.vercel.app/id/daily-dua)       | Mendapatkan daftar isi berdasarkan bahasa dan kategori                     | `*GET*` |
-| [`/:lang/:category/:id`](https://dua-dhikr.vercel.app/id/daily-dua/1) | Mengambil detail Doa & Dzikir berdasarkan bahasa, kategori dan ID spesifik | `*GET*` |
+| Titik Akhir                                                                    | Deskripsi                                                     | Metode  |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------- | ------- |
+| [`/languages`](https://dua-dhikr.vercel.app/languages)                         | Mendapatkan daftar bahasa yang di dukung                      | _`GET`_ |
+| [`/categories`](https://dua-dhikr.vercel.app/categories)                       | Mendapatkan daftar kategori doa & dzikir                      | _`GET`_ |
+| [`/categories/:slug`](https://dua-dhikr.vercel.app/categories/daily-dua)       | Mendapatkan daftar doa & dzikir berdasarkan kategori tertentu | _`GET`_ |
+| [`/categories/:slug/:id`](https://dua-dhikr.vercel.app/categories/daily-dua/1) | Mendapatkan detail doa & dzikir berdasarkan kategori dan id   | _`GET`_ |
+
+> [!IMPORTANT]
+> Untuk mendapatkan data dengan bahasa yang didukung, gunakan header `Accept-Language`. Secara bawaan akan menggunakan `id` (Bahasa Indonesia).
 
 ### Pameran
 
@@ -86,16 +89,16 @@ Daftar _server_ API yang siap digunakan secara publik
 
 Lengkapi atau tambah data Doa & Dzikir sesuai Sunnah yang kamu tahu, pastikan data tersebut shahih!
 
-> **Warning**<br>
+> [!WARNING]
 > Bertakwalah kepada Allah! Kontribusimu akan dihisab kelak di akhirat!
 
 1. _Fork_ repositori ini
-2. Buka `data/` dan pilih bahasa yang sudah ada (atau tambahkan baru), gunakan kode `ISO 639`
-3. Buka berkas JSON di kategori yang diinginkan
+2. Buka `data/dua-dhikr` dan pilih kategori yang tersedia
+3. Buka berkas JSON pada bahasa yang diinginkan, atau tambah baru dengan kode `ISO 639`
 4. Lakukan perubahan dengan hati-hati!
 5. _Commit_ perubahan dengan perintah `yarn commit`.
 6. Ajukan _pull-request_
-7. Tunggu _owner_ melakukan _merge_
+7. Tunggu kami melakukan _merge_
 
 ### Catatan
 

diff --git a/README.md b/README.md
@@ -58,17 +58,20 @@ A free RESTful API server that provides Duas and Dhikr following the Sunnah of t
 The fastest way to use it privately on PaaS available
 
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffitrahive%2Fdua-dhikr%2Ftree%2Fmain)
-[![Deploy with Cyclic](https://ik.imagekit.io/sooluh/cyclic.svg)](https://app.cyclic.sh/#/join/sooluh)
 
 ## Basic Usage
 
 Base URL : [`http://localhost:3000`](https://dua-dhikr.vercel.app)
 
-| Endpoint                                                              | Description                                                                    | Method |
-| --------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------ |
-| [`/:lang`](https://dua-dhikr.vercel.app/id)                           | Obtaining a list of Duas & Dhikr in a specific language                        | `GET`  |
-| [`/:lang/:category`](https://dua-dhikr.vercel.app/id/daily-dua)       | Getting a table of contents based on language and category                     | `GET`  |
-| [`/: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`  |
+| Endpoint                                                                       | Description                                                | Method |
+| ------------------------------------------------------------------------------ | ---------------------------------------------------------- | ------ |
+| [`/languages`](https://dua-dhikr.vercel.app/languages)                         | Retrieve a list of supported languages                     | `GET`  |
+| [`/categories`](https://dua-dhikr.vercel.app/categories)                       | Retrieve a list of dua & dhikr categories                  | `GET`  |
+| [`/categories/:slug`](https://dua-dhikr.vercel.app/categories/daily-dua)       | Retrieve a list of dua & dhikr based on a category         | `GET`  |
+| [`/categories/:slug/:id`](https://dua-dhikr.vercel.app/categories/daily-dua/1) | Retrieve details of a dua & dhikr based on category and id | `GET`  |
+
+> [!IMPORTANT]
+> To retrieve data in supported language, use the `Accept-Language` header. By default, it will use `id` (Indonesian).
 
 ### Showcase
 
@@ -86,16 +89,16 @@ List of server APIs ready to use publicly
 
 Complete or add Duas and Dhikr data according to the authentic Sunnah that you know, ensure the data is authentic!
 
-> **Warning**<br>
+> [!WARNING]
 > Fear Allah! Your contributions will be accounted for in the Hereafter!
 
 1. Fork this repository
-2. Go to the `data/` and navigate to the existing language (or add one), use `ISO 639` code
-3. Open the JSON file in the desired category
-4. Make change carefully!
+2. Open `data/dua-dhikr` and select an available category
+3. Open the JSON file in the desired language, or add a new one with the `ISO 639` code
+4. Make changes carefully!
 5. Commit the change using the command `yarn commit`.
-6. Create a pull-request
-7. Wait for the owner to merge
+6. Submit a pull-request
+7. Wait for us to perform the merge
 
 ### Note