aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc105
1 files changed, 89 insertions, 16 deletions
diff --git a/README.adoc b/README.adoc
index f1a9de2..0dcef73 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,35 +1,108 @@
= kbbi
-kbbi adalah antarmuka perintah dan pustaka bahasa Go untuk situs
-https://kbbi.kemdikbud.go.id[Kamus Besar Bahasa Indonesia (KBBI)].
+Proyek sumber terbuka implementasi antar-muka perintah dan API untuk Kamus
+Besar Bahasa Indonesia.
-== Penggunaan
-Secara sederhana, perintah `kbbi` menerima satu atau lebih parameter berupa
-kata-kata yang ingin diketahui maknanya dalam Bahasa Indonesia.
+== Program kbbi
+
+Program kbbi yaitu antar-muka untuk mencari definisi dari kata lewat baris
+perintah.
+
+Program ini sangat sederhana, caranya yaitu dengan memberikan kata yang dicari
+setelah nama program, misalnya,
----
-$ kbbi <KATA>...
+$ kbbi kamus,bahasa
----
-Contoh penggunaan,
+Maka akan mencetak definisi dari kata "kamus" dan "bahasa" ke layar,
----
-$ kbbi bahasa
-=== bahasa :
- Definisi 1: sistem lambang bunyi yang arbitrer, yang digunakan oleh anggota suatu masyarakat untuk bekerja sama, berinteraksi, dan mengidentifikasikan diri
+=== bahasa
+ Definisi #1: sistem lambang bunyi yang arbitrer, yang digunakan oleh
+ anggota suatu masyarakat untuk bekerja sama, berinteraksi, dan
+ mengidentifikasikan diri
Kelas #1: Nomina: kata benda
Kelas #2: Linguistik: -
- Definisi 2: percakapan (perkataan) yang baik; tingkah laku yang baik; sopan santun
+ Definisi #2: percakapan (perkataan) yang baik; tingkah laku yang baik; sopan santun
Kelas #1: Nomina: kata benda
Contoh #1: baik budi --nya
- Definisi 3: sistem kata atau simbol yang memungkinkan untuk berkomunikasi dengan komputer, terutama untuk memasukkan instruksi-instruksi komputer melalui kata-kata yang mudah dipahami, dan kemudian diterjemahkan ke dalam kode mesin
+ ...
+
+=== kamus
+ Definisi #1: karya rujukan atau acuan dalam bentuk cetak maupun digital yang
+ memuat kata dan ungkapan, dapat disusun menurut abjad atau tema, berisi
+ keterangan tentang makna, pemakaian, atau terjemahan
+ Kelas #1: Nomina: kata benda
+
+ Definisi #2: buku yang memuat kumpulan istilah atau nama yang disusun
+ menurut abjad beserta penjelasan tentang makna dan pemakaiannya
Kelas #1: Nomina: kata benda
- Kelas #2: Komputer: -
+
+ ...
+----
+
+Unduh program KBBI untuk sistem operasi Anda,
+
+* https://kilabit.info/project/kbbi/bin/kbbi-linux-amd64.gz[Linux 64bit]
+* https://kilabit.info/project/kbbi/bin/kbbi-darwin-amd64.gz[macOS 64bit]
+* https://kilabit.info/project/kbbi/bin/kbbi-windows-amd64.gz[Windows 64bit]
+
+
+== Bot Telegram
+
+Dengan tersedianya API, membuka banyak implementasi terbuka lain, salah
+satunya yaitu Bot untuk aplikasi Telegram: https://t.me/KamuskuBot
+
+Untuk saat ini, KamuskuBot hanya punya satu perintah yaitu "/definisi". Cara
+menggunakan perintah ini hampir sama dengan program kbbi yaitu dengan
+memberikan kata yang dicari, contohnya,
+
----
+/definisi kamus,bahasa
+----
+
+
+== KBBI API
+
+KBBI API adalah jantung dari semua implementasi di atas dan pencarian definisi
+kata di bawah. KBBI API dapat diakses menggunakan HTTP lewat URL berikut:
+https://kilabit.info/project/kbbi/api
+
+
+=== API Definisi
+
+HTTP API untuk mencari definisi dari satu atau lebih kata.
+
+Format permintaan,
+
+----
+GET /definisi?kata=<string>,...
+----
+
+Format respons dalam JSON,
+
+----
+{
+ "<string>": {
+ "dasar": "<string>",
+ "definisi": [{
+ "isi": "<string>",
+ "kelas": [<string>],
+ "contoh": [<string>]
+ },
+ ...
+ ]
+ }
+}
+----
+
+Berikut contoh pemanggilan API untuk mencari definisi dari kata "kamus" dan
+"bahasa",
+
+https://kilabit.info/project/kbbi/api/definisi?kata=kamus,bahasa
-Untuk setiap kata dalam argumen tersebut akan dicetak dengan prefiks "==="
-kemudian diikuti oleh satu atau lebih kelas kata dan contoh penggunaan dari
-kata tersebut.
+Sekian, selamat meretas!