kanabarum 0.2.0 → 0.2.2

package/README.md

@@ -1,7 +1,7 @@
 # Kanabarum - 가나발음
 
-일본어 히라가나/가타카나 문자열을 한국어 발음 표기로 바꿔주는 TypeScript 라이브러리입니다.  
-`kuromoji` 품사 분석을 이용해 は/へ 같은 조사를 안전하게 치환합니다.
+일본어 히라가나/가타카나/한자 문자열을 한국어 발음 표기로 바꿔주는 TypeScript 라이브러리입니다.
+`kuromoji` 품사 분석을 이용해 は/へ 같은 조사를 안전하게 치환하고, 한자는 발음으로 변환합니다.
 
 ## 설치
 
@@ -20,86 +20,90 @@ npm install kanabarum
 ```ts
 import { kanaToHangul } from "kanabarum";
 
-const text = await kanaToHangul("さようなら"); 
+const text = await kanaToHangul("さようなら");
 // => "사요나라"
 ```
 
-### 초기화 후 호출
+### 클래스 기반 호출
 
 ```ts
-import { KanaBarum } from "kanabarum";
+import { Kanabarum } from "kanabarum";
 
-const converter = await KanaBarum.init();
+const kanabarum = new Kanabarum();
+await kanabarum.init();
 
 // 인사말
-converter("おはよう"); // => "오하요"
-converter("こんにちは"); // => "곤니치와"
-converter("こんばんは"); // => "곰방와"
-converter("ありがとう"); // => "아리가토"
-converter("すみません"); // => "스미마셍"
+kanabarum.kanaToHangul("おはよう"); // => "오하요"
+kanabarum.kanaToHangul("こんにちは"); // => "곤니치와"
+kanabarum.kanaToHangul("こんばんは"); // => "곰방와"
+kanabarum.kanaToHangul("ありがとう"); // => "아리가토"
+kanabarum.kanaToHangul("すみません"); // => "스미마셍"
 
 // 요음
-converter("きゃく"); // => "캬쿠"
-converter("しゅくだい"); // => "슈쿠다이"
-converter("ちょっと"); // => "춋토"
-converter("きゅう"); // => "큐"
-converter("りょこう"); // => "료코"
+kanabarum.kanaToHangul("きゃく"); // => "캬쿠"
+kanabarum.kanaToHangul("しゅくだい"); // => "슈쿠다이"
+kanabarum.kanaToHangul("ちょっと"); // => "춋토"
+kanabarum.kanaToHangul("きゅう"); // => "큐"
+kanabarum.kanaToHangul("りょこう"); // => "료코"
 
 // つ 발음
-converter("つき"); // => "츠키"
-converter("つなみ"); // => "쓰나미"
+kanabarum.kanaToHangul("つき"); // => "츠키"
+kanabarum.kanaToHangul("つなみ"); // => "쓰나미"
 
 // 촉음
-converter("きって"); // => "킷테"
-converter("がっこう"); // => "각코"
-converter("けっこん"); // => "켓콘"
-converter("ざっし"); // => "잣시"
-converter("やっちゃった"); // => "얏챳타"
+kanabarum.kanaToHangul("きって"); // => "킷테"
+kanabarum.kanaToHangul("がっこう"); // => "각코"
+kanabarum.kanaToHangul("けっこん"); // => "켓콘"
+kanabarum.kanaToHangul("ざっし"); // => "잣시"
+kanabarum.kanaToHangul("やっちゃった"); // => "얏챳타"
 
 // ん 규칙
-converter("にゃんこ"); // => "냥코"
-converter("さんぽ"); // => "삼포"
-converter("しんぶん"); // => "심분"
-converter("りんご"); // => "링고"
-converter("まんいち"); // => "만이치"
+kanabarum.kanaToHangul("にゃんこ"); // => "냥코"
+kanabarum.kanaToHangul("さんぽ"); // => "삼포"
+kanabarum.kanaToHangul("しんぶん"); // => "심분"
+kanabarum.kanaToHangul("りんご"); // => "링고"
+kanabarum.kanaToHangul("まんいち"); // => "만이치"
 
 // 조사치환 は → わ
-converter("わたしはがくせいです"); // => "와타시와가쿠세데스"
-converter("これはペンです"); // => "코레와펜데스"
-converter("きょうはあつい"); // => "쿄와아츠이"
+kanabarum.kanaToHangul("わたしはがくせいです"); // => "와타시와가쿠세데스"
+kanabarum.kanaToHangul("これはペンです"); // => "코레와펜데스"
+kanabarum.kanaToHangul("きょうはあつい"); // => "쿄와아츠이"
 
 // 조사치환 へ → え
-converter("がっこうへいく"); // => "각코에이쿠"
-converter("うちへかえる"); // => "우치에카에루"
+kanabarum.kanaToHangul("がっこうへいく"); // => "각코에이쿠"
+kanabarum.kanaToHangul("うちへかえる"); // => "우치에카에루"
 
 // 장모음(おう/よう/えい) 축약
-converter("さようなら"); // => "사요나라"
-converter("せんせい"); // => "센세"
-converter("おおさか"); // => "오사카"
+kanabarum.kanaToHangul("さようなら"); // => "사요나라"
+kanabarum.kanaToHangul("せんせい"); // => "센세"
+kanabarum.kanaToHangul("おおさか"); // => "오사카"
 
 // 가타카나
-converter("カタカナ"); // => "카타카나"
-converter("コーヒー"); // => "코히"
-converter("アイドル"); // => "아이도루"
+kanabarum.kanaToHangul("カタカナ"); // => "카타카나"
+kanabarum.kanaToHangul("コーヒー"); // => "코히"
+kanabarum.kanaToHangul("アイドル"); // => "아이도루"
 
 // 장음 기호 변형(ー variants)
-converter("コーヒー"); // => "코히"
-converter("パーティー"); // => "파티"
-converter("ゲーム"); // => "게무"
+kanabarum.kanaToHangul("コーヒー"); // => "코히"
+kanabarum.kanaToHangul("パーティー"); // => "파티"
+kanabarum.kanaToHangul("ゲーム"); // => "게무"
 
 // 커스텀 사전
-converter("すみません"); // => "스미마셍"
-converter("かわいい"); // => "카와이"
-converter("はひふへほ"); // => "하히후헤호"
+kanabarum.kanaToHangul("すみません"); // => "스미마셍"
+kanabarum.kanaToHangul("かわいい"); // => "카와이"
+kanabarum.kanaToHangul("はひふへほ"); // => "하히후헤호"
 
-// 한자포함
-converter("誕生日(たんじょうび)"); // => "誕生日(탄죠비)"
-converter("第3回(だいさんかい)"); // => "第3回(다이상카이)"
-converter("京都(きょうと)"); // => "京都(쿄토)"
+// 한자 (발음으로 자동 변환)
+kanabarum.kanaToHangul("東京"); // => "도쿄"
+kanabarum.kanaToHangul("日本語"); // => "니홍고"
+kanabarum.kanaToHangul("東京とりんご"); // => "도쿄토링고"
 
-// 특수문자, 마침표
-converter("コーヒー, ください。"); // => "코히, 쿠다사이。"
-converter("「きょう」"); // => "「쿄」"
-converter("（がっこう）"); // => "（각코）"
+// 한자 + 후리가나
+kanabarum.kanaToHangul("誕生日(たんじょうび)"); // => "탄죠비(탄죠비)"
+kanabarum.kanaToHangul("京都(きょうと)"); // => "쿄토(쿄토)"
 
+// 특수문자, 마침표
+kanabarum.kanaToHangul("コーヒー, ください。"); // => "코히, 쿠다사이。"
+kanabarum.kanaToHangul("「きょう」"); // => "「쿄」"
+kanabarum.kanaToHangul("（がっこう）"); // => "（각코）"
 ```