@yxw007/translate 0.0.1-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Potter.yan
+
+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,88 @@
+# Translate
+
+English | [简体中文](./README_zh-CN.md)
+
+![GitHub top language](https://img.shields.io/github/languages/top/yxw007/translate)
+![GitHub License](https://img.shields.io/github/license/yxw007/translate)
+
+## ❓ Why do I need translate?
+1. a lot of translation tool libraries on the market, basically not very well-maintained
+2. not written by ts, not friendly enough when using the prompts
+3. single function, does not support batch translation Or only support a translation engine
+4. ...
+
+> Note: Translate helps you to solve all the above problems, and will expand more in the future!
+
+## ✨ Features
+- 🌐 **Multi-environment support**: Node environment, browser environment
+- ✨ **Easy to use**: provides a concise API, you can easily help you to translate
+- 🌍 **Multi-translation engine support**: Google, Azure Translate, etc. (will expand more in the future)
+- 🛠️ **typescript**: friendlier code hints and quality assurance
+- 📦 **Batch translation**: one api request, translate more content, reduce http requests to improve translation efficiency
+- 🔓 **completely open source**.
+
+## 🚀 Install
+
+- npm
+
+  ```bash
+  npm install @yxw007/translate
+  ```
+
+- yarn
+
+  ```bash
+  yarn add @yxw007/translate
+  ```
+
+- pnpm 
+
+  ```bash
+  pnpm i @yxw007/translate
+  ```
+
+## 📖 Usage
+
+- ESM
+
+  ```typescript
+  import { translator, engines } from "@yxw007/translate"
+
+  translator.use(engines.google());
+  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
+  console.log(res1);
+
+  const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
+  console.log(res2);
+  ```
+
+  output
+  ```bash
+  ['你好']
+  ["你好", "好的"]
+  ```
+
+- Commonjs
+
+  ```typescript
+  const { translator, engines }  = required("@yxw007/translate")
+
+  translator.use(engines.google());
+  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
+  console.log(res1);
+
+  const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
+  console.log(res2);
+
+  ```
+
+  output
+  ```bash
+  ['你好']
+  ["你好", "好的"]
+  ```
+
+## 📄 License
+
+Translate is released under the MIT license. See the [`LICENSE`](./LICENSE) file.
+

package/README_zh-CN.md

@@ -0,0 +1,90 @@
+# Translate
+
+简体中文 | [English](./README.md)
+
+![GitHub top language](https://img.shields.io/github/languages/top/yxw007/translate)
+![GitHub License](https://img.shields.io/github/license/yxw007/translate)
+
+Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套简单的api，让你可以轻松将一种语种翻译成另外一种语种。
+
+## ❓ 为什么需要Translate?
+1. 市面上不少翻译工具库，基本都不太维护了
+2. 不是ts写的，使用时提示不够友好
+3. 功能单一，不支持批量翻译 or 只支持一种翻译引擎
+4. ...
+
+> 说明：Translate 全部帮你搞定以上问题，未来将拓展更多内容
+
+## ✨ 特点
+- 🌐 **多环境支持**：Node环境、浏览器环境
+- ✨ **简单易用**：提供了简洁的API，就可以轻松帮你翻译
+- 🌍 **支持多翻译引擎**：Google、Azure Translate等（未来将拓展更多）
+- 🛠️ **typescript**: 更友好的代码提示和质量保障
+- 📦 **批量翻译**：一次api请求，翻译更多内容，减少http请求提高翻译效率
+- 🔓 **完全开源**
+
+
+## 🚀 安装
+
+- npm
+
+  ```bash
+  npm install @yxw007/translate
+  ```
+
+- yarn
+
+  ```bash
+  yarn add @yxw007/translate
+  ```
+
+- pnpm 
+
+  ```bash
+  pnpm i @yxw007/translate
+  ```
+
+## 📖 使用
+
+- ESM
+
+  ```typescript
+  import { translator, engines } from "@yxw007/translate"
+
+  translator.use(engines.google());
+  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
+  console.log(res1);
+
+  const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
+  console.log(res2);
+  ```
+
+  输出结果
+  ```bash
+  ['你好']
+  ["你好", "好的"]
+  ```
+
+- Commonjs
+
+  ```typescript
+  const { translator, engines }  = required("@yxw007/translate")
+
+  translator.use(engines.google());
+  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
+  console.log(res1);
+
+  const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
+  console.log(res2);
+
+  ```
+
+  输出结果
+  ```bash
+  ['你好']
+  ["你好", "好的"]
+  ```
+
+## 📄 许可证
+
+Translate 是在 MIT 许可证下发布的。详情请见 [`LICENSE`](./LICENSE) 文件。