konglish 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Konglish
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# Konglish - 콩글리시 변환기
+
+영어/외래어 문장을 한국어 발음 표기로 바꿔주는 TypeScript 라이브러리입니다.    
+영어는 발음매칭이 어렵기 때문에, 커스텀사전을 사용해서 매칭했습니다.
+사전에 없는 단어라면, cmu-pronouncing-dictionary를 사용해 한국어 발음으로 변환했습니다.
+
+## 설치
+
+```bash
+pnpm add konglish
+# 또는
+npm install konglish
+yarn add konglish
+```
+
+## 사용법
+
+### 간편 호출
+
+```ts
+import { latinToHangul } from "konglish";
+
+latinToHangul("good morning"); // "굿 모닝"
+latinToHangul("coffee time"); // "커피 타임"
+latinToHangul("family vacation"); // "패밀리 베케이션"
+latinToHangul("weekend movie night"); // "위켄드 무비 나이트"
+latinToHangul("happy birthday"); // "해피 버스데이"
+latinToHangul("pizza party"); // "피자 파티"
+latinToHangul("music festival"); // "뮤직 페스티벌"
+latinToHangul("new project"); // "뉴 프로젝트"
+latinToHangul("thank you"); // "땡큐"
+latinToHangul("see you soon!"); // "씨 유 순!"
+```
+
+### 클래스 호출
+
+```ts
+import { Konglish } from "konglish";
+
+const konglish = new Konglish({
+  dictionary: {
+    latte: ["라떼"],
+    meetup: ["밋업"],
+  },
+});
+
+konglish.latinToHangul("latte meetup"); // "라떼 밋업"
+konglish.latinToHangul("simple lunch menu"); // "심플 런치 메뉴"
+```
+
+
+## 라이선스
+
+[MIT](./LICENSE)