@sideid/id-profanity-filter 1.11.13 → 1.13.0

package/README.md

@@ -1,548 +1,273 @@
-# ID-Profanity-Filter
+<div align="center">
+  <img alt="SideID - Profanity Filter" src="https://socialify.git.ci/SideeID/id-profanity-filter/image?custom_description=Library+JavaScript%2FTypeScript+untuk+mendeteksi%2C+menyensor%2C+dan+menganalisis+kata-kata+kotor+dalam+Indonesia+dan+daerah.&description=1&font=Inter&forks=1&language=1&name=1&owner=1&pattern=Circuit+Board&stargazers=1&theme=Auto">
+</div>
 
-![License](https://img.shields.io/npm/l/@sideid/id-profanity-filter)
-![Version](https://img.shields.io/npm/v/@sideid/id-profanity-filter)
-![Downloads](https://img.shields.io/npm/dt/@sideid/id-profanity-filter)
+---
 
-Library JavaScript/TypeScript untuk mendeteksi, menyensor, dan menganalisis kata-kata kotor dalam Bahasa Indonesia dan bahasa daerah.
+<div align="center">
+  <a href="https://www.npmjs.com/package/@sideid/id-profanity-filter">
+    <img src="https://img.shields.io/npm/v/@sideid/id-profanity-filter.svg" alt="NPM Version">
+  </a>
+  <a href="https://github.com/SideeID/id-profanity-filter">
+    <img src="https://img.shields.io/github/license/SideeID/id-profanity-filter" alt="GitHub License">
+  </a>
+</div>
 
-## Fitur Utama
+# id-profanity-filter
 
-- 🔍 **Deteksi Kata Kotor** - Mendeteksi kata-kata kasar/kotor dalam teks Bahasa Indonesia
-- ⚠️ **Analisis Konten** - Menganalisis tingkat keparahan dan kategori kata kotor
-- 🔒 **Penyensoran** - Menyensor kata-kata kotor dengan berbagai opsi kustomisasi
-- 🗺️ **Dukungan Bahasa Daerah** - Mencakup kata-kata dari berbagai daerah di Indonesia (Jawa, Sunda, Batak, dll)
-- 🧠 **Deteksi Cerdas** - Mendeteksi variasi ejaan, kata terpisah, dan kesamaan kata
-- 🔠 **Deteksi Levenshtein** - Mendeteksi kata kotor yang dimodifikasi dengan typo atau sengaja disamarkan
-- 🛡️ **Preset** - Preset filter siap pakai untuk berbagai kebutuhan
-- 🔧 **Kustomisasi** - Opsi untuk menambahkan whitelist dan daftar kata kustom
+Library JavaScript dan TypeScript untuk mendeteksi, menyensor, dan menganalisis kata kotor dalam bahasa Indonesia serta berbagai bahasa daerah.
+
+## Fitur
+
+- Deteksi kata kotor dan umpatan dalam bahasa Indonesia dan dialek daerah (Jawa, Sunda, Batak, Betawi, Minang, Bali, Madura, Aceh)
+- Sensor fleksibel: ganti karakter (`*`, `#`), grawlix acak (`#@$%&!`), sensor penuh, atau pertahankan huruf pertama dan terakhir
+- Deteksi variasi penulisan: leetspeak (`4nj1ng`), kata terpisah (`a-n-j-i-n-g`), dan typo via Levenshtein distance
+- Analisis teks: skor keparahan (0-1), kategorisasi, analisis per kalimat, pencarian konteks sekitar, dan batch analysis
+- Mendukung whitelist kata dan daftar kata kustom (`wordList`)
+- Preset siap pakai: `strict`, `moderate`, `light`, dan `childSafe`
+- Dukungan penuh TypeScript dengan tipe data lengkap
 
 ## Instalasi
 
 ```bash
 npm install @sideid/id-profanity-filter
 # atau
-yarn add @sideid/id-profanity-filter
+bun add @sideid/id-profanity-filter
 # atau
 pnpm add @sideid/id-profanity-filter
 ```
 
-## Penggunaan Dasar
+## Penggunaan dasar
 
-### JavaScript / TypeScript
+### Menggunakan class IDProfanityFilter
 
 ```typescript
 import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-// Buat instance filter
 const filter = new IDProfanityFilter();
-
-// Cek apakah teks mengandung kata kotor
 const teks = 'Dasar anjing kamu, jangan banyak bacot!';
-const hasProfanity = filter.isProfane(teks);
-
-console.log(hasProfanity); // Output: true
-
-// Filter kata kotor (sensorisasi)
-const hasil = filter.filter(teks);
-console.log(hasil.filtered); // Output: "Dasar ***** kamu, jangan banyak *****!"
-console.log(hasil.censored); // Output: 2 (jumlah kata yang disensor)
-
-// Analisis konten
-const analisis = filter.analyze(teks);
-console.log(analisis.severityScore); // Output: 0.65 (contoh skor keparahan)
-console.log(analisis.categories); // Output: ["profanity", "insult"]
-```
-
-### Menggunakan Preset
-
-```typescript
-import IDProfanityFilter from '@sideid/id-profanity-filter';
-
-// Buat instance filter dengan preset
-const filter = new IDProfanityFilter();
-filter.usePreset('strict');
-
-// Atau dengan opsi tambahan
-filter.usePreset('childSafe', {
-  replaceWith: '#',
-  useRandomGrawlix: true,
-});
 
-const teks = 'Dasar anjing kamu, jangan banyak bacot!';
-const hasil = filter.filter(teks);
-console.log(hasil.filtered); // Output: "Dasar #@$%& kamu, jangan banyak $!@#%!"
+// Cek apakah teks mengandung kata kotor
+if (filter.isProfane(teks)) {
+  // Sensor kata kotor
+  const hasil = filter.filter(teks);
+  console.log(hasil.filtered);
+  // Output: "Dasar ****** kamu, jangan banyak *****!"
+  console.log(hasil.censored);
+  // Output: 2
+
+  // Analisis detail
+  const analisis = filter.analyze(teks);
+  console.log(analisis.categories);
+  // Output: ["profanity", "insult"]
+  console.log(analisis.regions);
+  // Output: ["general", "jawa"]
+  console.log(analisis.severityScore);
+  // Output: 0.36
+}
 ```
 
-### Utilitas Langsung
+### Menggunakan fungsi statis (idFilter)
 
-Anda juga dapat menggunakan fungsi utilitas langsung tanpa membuat instance:
+Jika tidak memerlukan konfigurasi instance khusus, gunakan helper `idFilter`:
 
 ```typescript
 import { idFilter } from '@sideid/id-profanity-filter';
 
 const teks = 'Dasar anjing kamu, jangan banyak bacot!';
+
+// Filter langsung
 const hasil = idFilter.filter(teks);
-console.log(hasil.filtered); // Output: "Dasar ***** kamu, jangan banyak *****!"
+console.log(hasil.filtered);
 
-// Menggunakan preset dengan API fungsi statis
-const presetResult = idFilter.filter(
-  teks,
-  idFilter.getPresetOptions('moderate'),
-);
+// Cek cepat
+console.log(idFilter.isProfane(teks)); // true
 ```
 
-## Dokumentasi API
-
-### Kelas `IDProfanityFilter`
-
-#### Konstruktor
+### Menggunakan preset
 
 ```typescript
-constructor(options?: FilterOptions)
-```
-
-- **options**: Opsi konfigurasi filter (opsional)
-
-#### Metode
-
-##### `filter(text: string): FilterResult`
-
-Menyensor kata kotor dalam teks.
-
-- **Hasil**: Objek `FilterResult` dengan properti:
-  - `filtered`: String teks yang sudah disensor
-  - `censored`: Jumlah kata yang disensor
-  - `replacements`: Array berisi detail kata yang disensor
-
-##### `isProfane(text: string): boolean`
-
-Memeriksa apakah teks mengandung kata kotor.
-
-- **Hasil**: Boolean `true` jika teks mengandung kata kotor, `false` jika tidak
-
-##### `analyze(text: string): AnalysisResult`
-
-Menganalisis teks untuk mendapatkan informasi detail tentang kata kotor yang ditemukan.
-
-- **Hasil**: Objek `AnalysisResult` dengan properti:
-  - `hasProfanity`: Apakah teks mengandung kata kotor
-  - `matches`: Array kata kotor yang ditemukan
-  - `matchDetails`: Array objek kata kotor dengan metadata
-  - `categories`: Kategori kata kotor yang ditemukan
-  - `regions`: Daerah asal kata kotor yang ditemukan
-  - `severityScore`: Skor keparahan (0-1)
-  - `similarWords`: Kata-kata yang mirip dengan kata kotor (jika deteksi kesamaan diaktifkan)
-
-##### `batchAnalyze(texts: string[])`
-
-Menganalisis batch teks sekaligus dan memberikan ringkasan.
-
-- **Hasil**: Objek yang berisi ringkasan analisis
-
-##### `analyzeBySentence(text: string)`
-
-Menganalisis teks per-kalimat.
-
-- **Hasil**: Array dari hasil analisis per-kalimat
-
-##### `analyzeWithContext(text: string, contextWindowSize?: number)`
+import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-Menganalisis teks dengan konteks di sekitar kata kotor.
+const filter = new IDProfanityFilter();
 
-- **Hasil**: Array dari kata kotor dengan konteks di sekitarnya
+// Gunakan preset childSafe dengan grawlix acak
+filter.usePreset('childSafe', { useRandomGrawlix: true });
 
-##### `usePreset(presetName: string, additionalOptions?: Partial<FilterOptions>)`
+const hasil = filter.filter('Dasar anjing kamu!');
+console.log(hasil.filtered);
+// Output: "Dasar #@$%& kamu!"
+```
 
-Menggunakan preset filter yang telah ditentukan.
+## Dokumentasi API
 
-- **presetName**: Nama preset ('strict', 'moderate', 'light', 'childSafe', dll)
-- **additionalOptions**: Opsi tambahan untuk override preset (opsional)
+### Kelas `IDProfanityFilter`
 
-##### `setOptions(options: Partial<FilterOptions>)`
+#### `constructor(options?: FilterOptions)`
+Membuat instance filter baru dengan opsi default atau kustom.
 
-Mengubah opsi filter.
+#### `filter(text: string): FilterResult`
+Menyensor kata kotor dalam teks. Mengembalikan objek:
+- `filtered`: string hasil sensor
+- `censored`: jumlah kata yang disensor
+- `replacements`: daftar objek penggantian (`original`, `censored`, `metadata`)
 
-##### `setWordList(wordList: string[])`
+#### `isProfane(text: string): boolean`
+Mengembalikan `true` jika teks mengandung kata kotor.
 
-Menetapkan daftar kata kustom.
+#### `analyze(text: string): AnalysisResult`
+Menganalisis teks secara menyeluruh. Mengembalikan objek:
+- `hasProfanity`: boolean
+- `matches`: string kata kotor yang cocok
+- `matchDetails`: array objek `ProfanityWord` lengkap
+- `categories`: kategori unik yang ditemukan
+- `regions`: daerah asal kata yang ditemukan
+- `severityScore`: skor keparahan kata (0 - 1)
+- `similarWords`: kata yang mirip (jika `detectSimilarity` aktif)
 
-##### `addToWhitelist(word: string)`
+#### `batchAnalyze(texts: string[])`
+Menganalisis kumpulan teks sekaligus dan mengembalikan statistik agregat (total kata, teks bersih, rata-rata keparahan, kata paling sering muncul).
 
-Menambahkan kata ke whitelist (akan diabaikan dalam filter).
+#### `analyzeBySentence(text: string)`
+Memecah teks per kalimat dan menganalisis masing-masing kalimat secara independen.
 
-##### `removeFromWhitelist(word: string)`
+#### `analyzeWithContext(text: string, contextWindowSize: number = 5)`
+Mengambil kata kotor beserta konteks kata-kata di sekitarnya.
 
-Menghapus kata dari whitelist.
+#### `setOptions(options: Partial<FilterOptions>)`
+Memperbarui konfigurasi filter yang sedang berjalan.
 
-##### `enableIndonesianVariations()`
+#### `resetOptions(options: FilterOptions = {})`
+Mengembalikan konfigurasi filter ke opsi default (dapat ditimpa dengan opsi baru).
 
-Mengaktifkan deteksi variasi ejaan Bahasa Indonesia.
+#### `usePreset(presetName: string, additionalOptions?: Partial<FilterOptions>)`
+Menerapkan preset filter (`strict`, `moderate`, `light`, `childSafe`).
 
-##### `enableSplitWordDetection()`
+#### `setWordList(wordList: string[])`
+Mengatur daftar kata kustom yang akan digunakan oleh filter.
 
-Mengaktifkan deteksi kata yang dipisah.
+#### `addToWhitelist(word: string)` / `removeFromWhitelist(word: string)`
+Menambahkan atau menghapus kata dari whitelist pengecualian.
 
-##### `enableSimilarityDetection(threshold: number = 0.8, useLevenshtein: boolean = false, maxLevenshteinDistance: number = 2)`
+#### `enableIndonesianVariations()`
+Mengaktifkan deteksi variasi ejaan bahasa Indonesia (misalnya ejaan lama atau substitusi huruf lazim).
 
-Mengaktifkan deteksi berdasarkan kesamaan kata.
+#### `enableSplitWordDetection()`
+Mengaktifkan deteksi kata yang dipisah dengan spasi atau tanda baca (contoh: `a-n-j-i-n-g`).
 
-- **threshold**: Ambang batas kesamaan (0-1, default: 0.8)
-- **useLevenshtein**: Gunakan algoritma Levenshtein untuk deteksi (default: false)
-- **maxLevenshteinDistance**: Jarak edit maksimum yang diizinkan (default: 2)
+#### `enableSimilarityDetection(threshold = 0.8, useLevenshtein = false, maxDistance = 2)`
+Mengaktifkan deteksi kemiripan kata untuk menangkap typo atau variasi penulisan.
 
-##### `enableLevenshteinDetection(threshold: number = 0.8, maxDistance: number = 2)`
+### Opsi Filter (`FilterOptions`)
 
-Mengaktifkan deteksi berbasis jarak Levenshtein.
+| Properti | Tipe | Default | Deskripsi |
+|---|---|---|---|
+| `replaceWith` | `string` | `'*'` | Karakter pengganti kata yang disensor |
+| `fullWordCensor` | `boolean` | `true` | Sensor seluruh karakter kata |
+| `keepFirstAndLast` | `boolean` | `false` | Pertahankan huruf pertama dan terakhir saat sensor (`a****g`) |
+| `useRandomGrawlix` | `boolean` | `false` | Gunakan karakter simbol acak (`#@$%&!`) |
+| `detectLeetSpeak` | `boolean` | `true` | Deteksi variasi angka/simbol (`b4b1`, `4nj1ng`) |
+| `detectSplit` | `boolean` | `false` | Deteksi kata dengan pemisah (`b-a-b-i`) |
+| `indonesianVariation` | `boolean` | `false` | Deteksi variasi ejaan Indonesia |
+| `detectSimilarity` | `boolean` | `false` | Deteksi kata typo atau mirip |
+| `similarityThreshold` | `number` | `0.8` | Batas minimum kemiripan (0 - 1) |
+| `useLevenshtein` | `boolean` | `false` | Gunakan algoritma Levenshtein distance |
+| `maxLevenshteinDistance` | `number` | `2` | Jarak edit maksimum Levenshtein |
+| `checkSubstring` | `boolean` | `false` | Deteksi kata kotor di dalam substring kata lain |
+| `wordList` | `string[]` | `[]` | Daftar kata kustom (menggantikan daftar bawaan) |
+| `whitelist` | `string[]` | `[]` | Daftar kata yang diabaikan dari filter |
+| `categories` | `ProfanityCategory[]` | - | Filter hanya kategori tertentu |
+| `regions` | `Region[]` | - | Filter hanya daerah tertentu |
+| `severityThreshold` | `number` | `0` | Batas keparahan minimum kata (0 - 1) |
 
-- **threshold**: Ambang batas kesamaan (0-1, default: 0.8)
-- **maxDistance**: Jarak edit maksimum yang diizinkan (default: 2)
+## Contoh penggunaan lanjutan
 
-### Opsi Filter
+### Daftar kata kustom
 
 ```typescript
-interface FilterOptions {
-  // Opsi dasar
-  wordList?: string[]; // List kata yang ingin difilter
-  replaceWith?: string; // Karakter pengganti untuk kata yang disensor
-  fullWordCensor?: boolean; // Apakah menyensor seluruh kata atau sebagian
-  detectLeetSpeak?: boolean; // Deteksi variasi penulisan (mis: a=4, e=3)
-  whitelist?: string[]; // Kata-kata yang dikecualikan dari filter
-  checkSubstring?: boolean; // Memeriksa substring (lebih ketat)
-  categories?: ProfanityCategory[]; // Kategori kata yang difilter
-  regions?: Region[]; // Daerah asal kata yang difilter
-  severityThreshold?: number; // Tingkat keparahan minimum (0-1)
-
-  // Opsi lanjutan
-  useRandomGrawlix?: boolean; // Gunakan karakter acak untuk sensor (#@$%&!)
-  keepFirstAndLast?: boolean; // Simpan huruf pertama dan terakhir (a***g)
-  indonesianVariation?: boolean; // Deteksi variasi ejaan Bahasa Indonesia
-  detectSimilarity?: boolean; // Deteksi kata berdasarkan kesamaan
-  similarityThreshold?: number; // Ambang batas kesamaan (0-1)
-  detectSplit?: boolean; // Deteksi kata yang dipisah (a-n-j-i-n-g)
-  useLevenshtein?: boolean; // Gunakan algoritma Levenshtein untuk deteksi kesamaan
-  maxLevenshteinDistance?: number; // Jarak edit maksimum untuk deteksi Levenshtein
-}
-```
-
-## Preset Filter
-
-Library ini menyediakan beberapa preset yang dapat digunakan:
-
-### Preset Filter
-
-- **strict**: Filter paling ketat, mendeteksi semua jenis kata kotor
-- **moderate**: Filter tingkat menengah, mengabaikan kata-kata dengan tingkat keparahan rendah
-- **light**: Filter ringan, hanya untuk kata-kata paling sensitif
-- **childSafe**: Filter untuk konten anak-anak, sangat ketat
-
-### Preset Kategori
-
-- **sexual**: Hanya memfilter kata-kata berbau seksual
-- **insults**: Hanya memfilter kata-kata penghinaan
-- **profanity**: Hanya memfilter umpatan umum
-
-### Preset Regional
-
-- **general**: Hanya memfilter kata-kata umum di Indonesia
-- **jawa**: Hanya memfilter kata-kata dari Jawa
-- **sunda**: Hanya memfilter kata-kata dari Sunda
-- **betawi**: Hanya memfilter kata-kata dari Betawi
-- **batak**: Hanya memfilter kata-kata dari Batak
-
-## Contoh Penggunaan Lanjutan
-
-### Kustomisasi Opsi Filter
+import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-```typescript
 const filter = new IDProfanityFilter({
-  replaceWith: '#', // Menggunakan # sebagai karakter pengganti
-  fullWordCensor: false, // Hanya menyensor sebagian kata
-  detectLeetSpeak: true, // Mendeteksi variasi seperti "b4b1" untuk "babi"
-  categories: ['sexual', 'slur'], // Hanya filter kategori tertentu
-  regions: ['jawa', 'general'], // Hanya filter dari daerah tertentu
-  severityThreshold: 0.7, // Hanya filter kata dengan tingkat keparahan ≥ 0.7
-
-  // Opsi lanjutan
-  useRandomGrawlix: true, // Gunakan #@$%&! sebagai karakter pengganti
-  keepFirstAndLast: true, // Simpan huruf pertama dan terakhir (a***g)
-  indonesianVariation: true, // Deteksi variasi ejaan Indonesia
-  detectSimilarity: true, // Deteksi kata yang mirip
-  similarityThreshold: 0.8, // Ambang batas kesamaan
-  detectSplit: true, // Deteksi kata yang dipisah
-  useLevenshtein: true, // Gunakan algoritma Levenshtein
-  maxLevenshteinDistance: 2, // Jarak Levenshtein maksimum
+  wordList: ['jelek', 'payah', 'curang'],
+  replaceWith: '#',
 });
-```
-
-### Menggunakan Whitelist
-
-```typescript
-const filter = new IDProfanityFilter();
-
-// Menambahkan kata ke whitelist (akan diabaikan)
-filter.addToWhitelist('anjing');
 
-const teks =
-  'Anjing itu hewan peliharaan yang setia, tidak seperti bajingan itu';
+const teks = 'Kualitas layanannya sangat jelek dan payah!';
 const hasil = filter.filter(teks);
 
 console.log(hasil.filtered);
-// Output: "Anjing itu hewan peliharaan yang setia, tidak seperti ******* itu"
-```
-
-### Deteksi Variasi Ejaan dan Kata Terpisah
-
-```typescript
-// Aktifkan deteksi variasi ejaan dan kata terpisah
-const filter = new IDProfanityFilter({
-  indonesianVariation: true,
-  detectSplit: true,
-  detectLeetSpeak: true,
-});
-
-// Uji dengan variasi ejaan
-const teks1 = 'Dasar kamu ini sangat bodoh, benar-benar b0d0h dan b-o-d-o-h!';
-const hasil1 = filter.filter(teks1);
-console.log(hasil1.filtered);
-// Output: "Dasar kamu ini sangat *****, benar-benar ***** dan *********!"
-
-// Uji dengan ejaan Indonesia yang berbeda
-const teks2 = 'Dia sangat djail dan djudes dengan temannya';
-const hasil2 = filter.filter(teks2);
-console.log(hasil2.filtered);
-// Output: "Dia sangat ***** dan ****** dengan temannya"
+// Output: "Kualitas layanannya sangat ##### dan #####!"
 ```
 
-### Deteksi Berdasarkan Kesamaan (Similarity Detection)
+### Deteksi typo dan Levenshtein distance
 
 ```typescript
-// Aktifkan deteksi kesamaan standar
-const filter = new IDProfanityFilter();
-filter.enableSimilarityDetection(0.75); // Set threshold kesamaan ke 0.75
-
-const teks = 'Dia benar-benar anjiing dan gooblok!';
-const analisis = filter.analyze(teks);
-
-console.log(analisis.similarWords);
-/* Output:
-[
-  { word: "anjiing", original: "anjing", similarity: 0.83 },
-  { word: "gooblok", original: "goblok", similarity: 0.85 }
-]
-*/
-
-const hasil = filter.filter(teks);
-console.log(hasil.filtered);
-// Output: "Dia benar-benar ****** dan *******!"
-```
-
-### Deteksi dengan Algoritma Levenshtein Distance
+import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-```typescript
-// Aktifkan deteksi menggunakan algoritma Levenshtein Distance
 const filter = new IDProfanityFilter();
-filter.enableLevenshteinDetection(0.85, 2);
-// Threshold 0.85, maksimal 2 karakter berbeda
+filter.enableLevenshteinDetection(0.8, 2);
 
-const teks = 'Dia benar-benar konntol dan anjiing sekali!';
+const teks = 'Dia benar-benar anjiing sekali!';
 const hasil = filter.filter(teks);
 
 console.log(hasil.filtered);
-// Output: "Dia benar-benar ******* dan ****** sekali!"
-
-// Atau menggunakan opsi langsung:
-const filterCustom = new IDProfanityFilter({
-  detectSimilarity: true,
-  useLevenshtein: true,
-  similarityThreshold: 0.85,
-  maxLevenshteinDistance: 2,
-});
-
-// Mendeteksi typo atau variasi disengaja
-const teksVariasi = 'kontool kamu kwontol anjiing';
-console.log(filterCustom.filter(teksVariasi).filtered);
-// Output: "******* kamu ******* ******"
+// Output: "Dia benar-benar ******* sekali!"
 ```
 
-### Variasi Sensor Kata
+### Whitelist kontekstual
 
 ```typescript
-// Sensor standar (asterisk)
-const filter1 = new IDProfanityFilter();
-console.log(filter1.filter('Dasar anjing kamu!').filtered);
-// Output: "Dasar ***** kamu!"
-
-// Sensor dengan grawlix random
-const filter2 = new IDProfanityFilter({ useRandomGrawlix: true });
-console.log(filter2.filter('Dasar anjing kamu!').filtered);
-// Output: "Dasar #@$%& kamu!"
-
-// Sensor dengan menyimpan huruf pertama dan terakhir
-const filter3 = new IDProfanityFilter({
-  fullWordCensor: false,
-  keepFirstAndLast: true,
-});
-console.log(filter3.filter('Dasar anjing kamu!').filtered);
-// Output: "Dasar a***g kamu!"
-```
-
-### Analisis Konten Mendalam
+import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-```typescript
 const filter = new IDProfanityFilter();
-const teks = 'Dasar anjing sialan! Kamu ini memang bego dan goblok.';
-
-// Analisis teks
-const analisis = filter.analyze(teks);
-console.log(analisis);
-
-/* Output:
-{
-  hasProfanity: true,
-  matches: ['anjing', 'sialan', 'bego', 'goblok'],
-  matchDetails: [
-    { word: 'anjing', category: 'profanity', region: 'general', severity: 0.7, ... },
-    { word: 'bego', category: 'insult', region: 'general', severity: 0.5, ... },
-    ...
-  ],
-  categories: ['profanity', 'insult'],
-  regions: ['general'],
-  severityScore: 0.64
-}
-*/
-```
-
-### Analisis Konteks
+filter.addToWhitelist('anjing');
 
-```typescript
-const filter = new IDProfanityFilter();
-const teks =
-  'Saya sangat marah dengan sikapnya, dia benar-benar anjing dan bajingan!';
-
-// Analisis konteks
-const konteks = filter.analyzeWithContext(teks, 3);
-console.log(konteks);
-
-/* Output:
-[
-  {
-    word: "anjing",
-    context: "benar-benar anjing dan bajingan",
-    position: { start: 43, end: 62 }
-  },
-  {
-    word: "bajingan",
-    context: "anjing dan bajingan!",
-    position: { start: 54, end: 63 }
-  }
-]
-*/
+const teks = 'Anjing peliharaan saya setia sekali.';
+console.log(filter.isProfane(teks)); // false
 ```
 
-### Analisis Per-Kalimat
+### Analisis per kalimat
 
 ```typescript
-const filter = new IDProfanityFilter();
-const teks =
-  'Filmnya bagus sekali. Tetapi pemainnya seperti anjing, sangat buruk aktingnya.';
-
-// Analisis per-kalimat
-const kalimat = filter.analyzeBySentence(teks);
-console.log(
-  kalimat.map(
-    (k) =>
-      k.sentence + (k.hasProfanity ? ' (Mengandung kata kotor)' : ' (Bersih)'),
-  ),
-);
-
-/* Output:
-[
-  "Filmnya bagus sekali. (Bersih)",
-  "Tetapi pemainnya seperti anjing, sangat buruk aktingnya. (Mengandung kata kotor)"
-]
-*/
-```
-
-### Analisis Batch
+import IDProfanityFilter from '@sideid/id-profanity-filter';
 
-```typescript
 const filter = new IDProfanityFilter();
-const komentar = [
-  'Film ini sangat bagus, ceritanya menarik sekali!',
-  'Dasar goblok, sialan kamu!',
-  'Anjing emang filmnya, sampah banget.',
-];
-
-const hasil = filter.batchAnalyze(komentar);
-console.log(hasil);
-
-/* Output:
-{
-  totalTexts: 3,
-  profaneTexts: 2,
-  cleanTexts: 1,
-  averageSeverity: 0.62,
-  topCategories: ['profanity', 'insult'],
-  topRegions: ['general'],
-  mostFrequentWords: [
-    { word: 'anjing', count: 1 },
-    { word: 'goblok', count: 1 },
-    { word: 'sialan', count: 1 },
-    { word: 'sampah', count: 1 }
-  ]
-}
-*/
-```
-
-## Dukungan Regional
-
-Library ini mendukung kata-kata kotor dari berbagai daerah di Indonesia:
-
-- 🇮🇩 **General** - Kata-kata yang umum di seluruh Indonesia
-- 🏝️ **Jawa** - Kata-kata dari bahasa Jawa
-- 🏞️ **Sunda** - Kata-kata dari bahasa Sunda
-- 🏙️ **Betawi** - Kata-kata dari bahasa Betawi
-- 🌋 **Batak** - Kata-kata dari bahasa Batak
-
-## Kategori Kata
-
-Kata-kata dikelompokkan berdasarkan kategori:
+const teks = 'Filmnya bagus sekali. Tapi pemainnya seperti anjing, aktingnya buruk.';
 
-- `sexual`: Kata-kata berbau seksual
-- `insult`: Kata-kata penghinaan
-- `profanity`: Umpatan umum
-- `slur`: Perkataan merendahkan berdasarkan identitas
-- `drugs`: Terkait narkoba
-- `disgusting`: Kata-kata menjijikkan
-- `blasphemy`: Penistaan agama
+const hasilKalimat = filter.analyzeBySentence(teks);
+hasilKalimat.forEach((item) => {
+  console.log(`${item.sentence} -> ${item.hasProfanity ? 'Kotor' : 'Bersih'}`);
+});
+// "Filmnya bagus sekali." -> Bersih
+// "Tapi pemainnya seperti anjing, aktingnya buruk." -> Kotor
+```
 
-## Berkontribusi
+## Cakupan daerah dan kategori
 
-Kami sangat menghargai kontribusi Anda! Untuk berkontribusi, silakan lihat [panduan kontribusi](CONTRIBUTING.md).
+### Bahasa daerah
+- `general`: Bahasa Indonesia umum
+- `jawa`: Bahasa Jawa
+- `sunda`: Bahasa Sunda
+- `betawi`: Dialek Betawi
+- `batak`: Bahasa Batak
+- `minang`: Bahasa Minang
+- `bali`: Bahasa Bali
+- `madura`: Bahasa Madura
+- `aceh`: Bahasa Aceh
 
-### Menambahkan Kata Baru
+### Kategori kata
+- `sexual`: Istilah atau aktivitas seksual vulgar
+- `insult`: Penghinaan atau caci maki
+- `profanity`: Umpatan kasar umum
+- `slur`: Kata merendahkan SARA / identitas
+- `drugs`: Istilah obat-obatan terlarang
+- `disgusting`: Kata jorok atau menjijikkan
+- `blasphemy`: Umpatan penistaan agama
 
-Jika Anda ingin menambahkan kata baru ke database, silakan buat pull request dengan mengubah file yang sesuai di `src/constants/categories/` atau `src/constants/regions/`.
+## Kontribusi
 
-Format untuk menambahkan kata baru:
-
-```json
-{
-  "word": "kata_kotor", // Kata yang akan difilter
-  "category": "insult", // Kategori kata
-  "region": "general", // Daerah asal kata
-  "severity": 0.7, // Tingkat keparahan (0-1)
-  "aliases": ["k4t4_kotor", "kata_k0t0r"], // Alias atau variasi umum
-  "description": "Deskripsi tentang kata", // Penjelasan tentang kata (opsional)
-  "context": "Konteks penggunaan kata" // Konteks penggunaan (opsional)
-}
-```
+Panduan untuk menambahkan kata baru atau mengembangkan library dapat dilihat di [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## Lisensi
 
-Proyek ini dilisensikan di bawah [MIT License](LICENSE).
-
-## Kontak & Dukungan
-
-Jika Anda memiliki pertanyaan atau saran, silakan buka issue di repositori GitHub kami.
+Proyek ini menggunakan lisensi [MIT](LICENSE).