Version 1.0.0 (#10)

Author: sgalal

.eslintrc.js

@@ -17,8 +17,8 @@ jobs:
       run: npm install -g rollup
     - name: Install dependencies
       run: npm ci
-    - name: Bundle
-      run: npm run bundle
+    - name: Build & Test
+      run: ./buildAndTest.sh
     - name: Publish
       run: npm publish
       env:

.github/workflows/npm-publish.yml

@@ -24,13 +24,5 @@ jobs:
       run: npm install -g rollup
     - name: Install dependencies
       run: npm ci
-    - name: Bundle
-      run: npm run bundle
-    - name: Test
-      run: npm test
-    - name: Speed Test
-      run: |
-        test/prepare.sh
-        npm run speedtest
-    - name: Lint
-      run: npm run lint
+    - name: Build & Test
+      run: ./buildAndTest.sh

.github/workflows/test.yml

@@ -1,6 +1,10 @@
 node_modules
 
+/data*.js
+/full.js
+
 /test/神雕侠侣.txt
 /test/天龙八部.txt
 
-/bundle.js
+/bundle-browser.js
+/bundle-node.js

.gitignore

@@ -0,0 +1,5 @@
+/.github
+/build.js
+/buildAndTest.sh
+/rollup.config.js
+/test

.npmignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Ngiox Khyen 2028 Project
+Copyright (c) 2020-2021 The nk2028 Project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -0,0 +1,75 @@
+# opencc-js [![](https://badge.fury.io/js/opencc-js.svg)](https://www.npmjs.com/package/opencc-js) [![](https://github.com/nk2028/opencc-js/workflows/Test/badge.svg)](https://github.com/nk2028/opencc-js/actions?query=workflow%3ATest) [![](https://data.jsdelivr.com/v1/package/npm/opencc-js/badge)](https://www.jsdelivr.com/package/npm/opencc-js)
+
+开放中文转换 JavaScript 版
+
+## 加载
+
+**在 HTML 中加载**
+
+依次加载以下四个 `script` 标签：
+
+```html
+<!-- 下面一条必须加载 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.min.js"></script>
+<!-- 不需要简转繁时，可删除下面一条，以加快加载 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.cn2t.min.js"></script>
+<!-- 不需要繁转简时，可删除下面一条，以加快加载 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.t2cn.min.js"></script>
+<!-- 下面一条必须加载 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/bundle-broswer.min.js"></script>
+```
+
+**在 Node.js 中加载**
+
+```sh
+npm install opencc-js
+```
+
+```javascript
+const OpenCC = require('opencc-js');
+```
+
+## 使用
+
+**基本用法**
+
+```javascript
+// 将繁体中文（香港）转换为简体中文（中国大陆）
+const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
+console.log(converter('漢字，簡體字')); // output: 汉字，简体字
+```
+
+- `cn`: 简体中文（中国大陆）
+- `tw`: 繁体中文（台湾）
+- `twp`: 繁体中文（台湾，且转换词汇）
+- `hk`: 繁体中文（香港）
+- `jp`: 日本新字体
+- `t`: 繁体中文（OpenCC 标准。除非你知道自己在做什么，否则请勿使用）
+
+**自订转换器**
+
+```javascript
+const converter = OpenCC.CustomConverter([
+  ['香蕉', 'banana'],
+  ['蘋果', 'apple'],
+  ['梨', 'pear'],
+]);
+console.log(converter('香蕉 蘋果 梨')); // output: banana apple pear
+```
+
+**DOM 操作**
+
+```javascript
+// 将繁体中文（香港）转换为简体中文（中国大陆）
+const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
+// 设置转换起点为根节点，即转换整个页面
+const rootNode = document.documentElement;
+// 将所有 zh-HK 标签转为 zh-CN 标签
+const HTMLConvertHandler = OpenCC.HTMLConverter(converter, rootNode, 'zh-HK', 'zh-CN');
+// 开始转换
+HTMLConvertHandler.convert();
+// 复原
+HTMLConvertHandler.restore();
+```
+
+class list 包含 `ignore-opencc` 的标签不会被转换（包括该标签的所有子节点）。

README-en.md

@@ -0,0 +1,75 @@
+# opencc-js [![](https://badge.fury.io/js/opencc-js.svg)](https://www.npmjs.com/package/opencc-js) [![](https://github.com/nk2028/opencc-js/workflows/Test/badge.svg)](https://github.com/nk2028/opencc-js/actions?query=workflow%3ATest) [![](https://data.jsdelivr.com/v1/package/npm/opencc-js/badge)](https://www.jsdelivr.com/package/npm/opencc-js)
+
+開放中文轉換 JavaScript 版
+
+## 載入
+
+**在 HTML 中載入**
+
+依次載入以下四個 `script` 標籤：
+
+```html
+<!-- 下面一條必須載入 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.min.js"></script>
+<!-- 不需要簡轉繁時，可刪除下面一條，以加快載入 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.cn2t.min.js"></script>
+<!-- 不需要繁轉簡時，可刪除下面一條，以加快載入 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/data.t2cn.min.js"></script>
+<!-- 下面一條必須載入 -->
+<script src="https://cdn.jsdelivr.net/npm/opencc-js@1.0.0/bundle-broswer.min.js"></script>
+```
+
+**在 Node.js 中載入**
+
+```sh
+npm install opencc-js
+```
+
+```javascript
+const OpenCC = require('opencc-js');
+```
+
+## 使用
+
+**基本用法**
+
+```javascript
+// 將繁體中文（香港）轉換為簡體中文（中國大陸）
+const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
+console.log(converter('漢字，簡體字')); // output: 汉字，简体字
+```
+
+- `cn`: 簡體中文（中國大陸）
+- `tw`: 繁體中文（臺灣）
+- `twp`: 繁體中文（臺灣，且轉換詞彙）
+- `hk`: 繁體中文（香港）
+- `jp`: 日本新字體
+- `t`: 繁體中文（OpenCC 標準。除非你知道自己在做什麼，否則請勿使用）
+
+**自訂轉換器**
+
+```javascript
+const converter = OpenCC.CustomConverter([
+  ['香蕉', 'banana'],
+  ['蘋果', 'apple'],
+  ['梨', 'pear'],
+]);
+console.log(converter('香蕉 蘋果 梨')); // output: banana apple pear
+```
+
+**DOM 操作**
+
+```javascript
+// 將繁體中文（香港）轉換為簡體中文（中國大陸）
+const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
+// 設定轉換起點為根節點，即轉換整個頁面
+const rootNode = document.documentElement;
+// 將所有 zh-HK 標籤轉為 zh-CN 標籤
+const HTMLConvertHandler = OpenCC.HTMLConverter(converter, rootNode, 'zh-HK', 'zh-CN');
+// 開始轉換
+HTMLConvertHandler.convert();
+// 復原
+HTMLConvertHandler.restore();
+```
+
+class list 包含 `ignore-opencc` 的標籤不會被轉換（包括該標籤的所有子節點）。