added documentation for international phonetic alphabet generator

faker-ruby · Jun 7, 2023 · 32bd862 · 32bd862
1 parent 3dc230b
commit 32bd862
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/doc/default/international_phonetic_alphabet.md b/doc/default/international_phonetic_alphabet.md
@@ -0,0 +1,15 @@
+# Faker::InternationalPhoneticAlphabet
+
+```Ruby
+Faker::InternationalPhoneticAlphabet.character             #=> "ʋ"
+
+Faker::InternationalPhoneticAlphabet.character(amount: 3)  #=> "zʐd"
+
+Faker::InternationalPhoneticAlphabet.consonant             #=> "ʂ"
+
+Faker::InternationalPhoneticAlphabet.consonant(amount: 3)  #=> "fʕŋ"
+
+Faker::InternationalPhoneticAlphabet.vowel                 #=> "ɞ"
+
+Faker::InternationalPhoneticAlphabet.vowel(amount: 3)      #=> "əæɜ"
+```