add README-CN

Author: PeterAlfredLee

README-CN.md

@@ -1,3 +1,147 @@
 # crypto-js-wasm
 
 [English](README.md) | [中文](README-CN.md)
+
+---
+
+`crypto-js-wasm` 是基于 JavaScript 和 [WebAssembly](https://webassembly.org/) 的哈西与加密算法库，其灵感来自于[crypto-js](https://github.com/brix/crypto-js)。
+
+- **安全**: 得益于 WebAssembly ，crypto-js-wasm的计算过程是**不可见、不可中断**的。
+- **高效**: 相比于crypto-js，计算效率最高提升了16倍(见 [Benchmark](https://originjs.org/WASM-benchmark/#/))。
+- **浏览器 & Nodejs**: 同时支持 `浏览器` 和 `nodejs`.
+- **全能**: 支持**15+** 以上的哈西和加密算法，包括常用的 MD5、 SHA-x、 AES、RC4等。
+- **ESM**: 基于ES模块语法编写，支持一部运行
+
+
+
+## 安装
+
+```bash
+npm install originjs@crypto-js-wasm
+```
+
+或
+
+```bash
+pnpm install originjs@crypto-js-wasm
+```
+
+或
+
+```bash
+yarn add originjs@crypto-js-wasm
+```
+
+
+
+## 使用
+
+在使用各算法前需调用一次对应的`loadWasm()`，或调用`loadAllWasm()`以加载所有算法的WebAssembly文件。
+
+
+
+```javascript
+import CryptoJSW from 'crypto-js-wasm';
+
+// (可选) 加载所有 wasm 文件
+await CryptoJSW.loadAllWasm();
+
+// 通过 Async/Await 语法调用
+await CryptoJSW.MD5.loadWasm();
+const rstMD5 = CryptoJSW.MD5('message').toString();
+console.log(rstMD5);
+
+// 通过 Promise 语法调用
+CryptoJSW.SHA256.loadWasm().then(() => {
+    const rstSHA256 = CryptoJSW.SHA256('message').toString();
+    console.log(rstSHA256);
+})
+```
+
+
+
+**目前可用的算法**
+
+- MD5 / HmacMD5
+- SHA1 / HmacSHA1
+- SHA224 / HmacSHA224
+- SHA256 / HmacSHA256
+- SHA384 / HmacSHA384
+- SHA512 / HmacSHA512
+- SHA3 / HmacSHA3
+- RIPEMD160 / HmacRIPEMD160
+- PBKDF2
+- EvpKDF
+
+<br>
+
+- AES
+- Blowfish
+- DES
+- TripleDES
+- Rabbit
+- RabbitLegacy
+- RC4
+- RC4Drop
+
+
+
+**下一步计划支持**
+
+- RSA
+
+
+
+## Benchmark
+
+该 benchmark 结果运行自一台台式机 (i5-4590, 16 GB RAM, Windows 10 Version 21H2 (OSBuild 19044, 1466))。
+
+
+
+*Chrome 102.0.5005.63:*
+
+![benchmark_chrome](/home/peterlee/code/crypto-js-wasm-originjs/crypto-js-wasm/benchmark/benchmark_chrome.png)
+
+
+
+Firefox 101.0:
+
+![benchmark_firefox](/home/peterlee/code/crypto-js-wasm-originjs/crypto-js-wasm/benchmark/benchmark_firefox.png)
+
+
+
+## 开发
+
+```bash
+# 安装以来
+pnpm install
+
+# 生产构建
+pnpm run build
+
+# 运行所有测试
+pnpm run test
+
+#  运行所有测试并生成测试覆盖率报告
+pnpm run coverage
+```
+
+
+
+#### 为何我们需要调用异步的 loadWasm？
+
+这是因为 WebAssembly 二进制需要通过 `WebAssembly.instantiate` 加载，并且这是一个异步函数。
+
+`WebAssembly.instantiate `与它的同步实现 `WebAssembly.instance` 相比，前者更受推荐；并且，在许多场景下，`WebAssembly.instance` 无法加载不够小的 WebAssembly 二进制。
+
+
+
+#### 为何我们需要以base64编码字符的方式，存储wasm二进制？
+
+因为 `crypto-js-wasm` 需要同时支持 `browser` 和 `nodejs` 两种使用场景。相比与 `browser` 中的 `wasm loader` (多数情况下由 webpack, vite 或其他框架提供)以及 `nodejs` 中的 `fs` 方式，这种wasm二进制存储方式是一种相对优雅的方式。
+
+
+
+## 版权说明
+
+该项目遵守[木兰宽松许可证](LICENSE)

README.md

@@ -8,6 +8,7 @@
 
 - **Safe**: The process of encryption is fully **enclosed** and **invisible** thanks to WebAssembly.
 - **Efficient**: Up to 16x **faster** than crypto-js (see [Benchmark](https://originjs.org/WASM-benchmark/#/)).
+- **Browser & Nodejs**: Support both `browser` and `nodejs`.
 - **Versatile**: **15+** crypto standards supported, including MD5, SHA-x, AES, RC4, etc.
 - **ESM**: Crypto standards can be imported as **ES modules**.
 
@@ -124,3 +125,23 @@ pnpm run test
 # run all tests with coverage
 pnpm run coverage
 ```
+
+
+
+#### Why do we need a async loadWasm call?
+
+This is because the WebAssembly binary needs to be load by `WebAssembly.instantiate`, and it is async. 
+
+The async `WebAssembly.instantiate` is recommended instead of its sync variant `WebAssembly.instance`, and in many cases the `WebAssembly.instance` can not load WebAssembly binary whose size is not small enough.
+
+
+
+#### Why do we store wasm binaries in base64-encoded chars?
+
+This is because  `crypto-js-wasm` may be used in `browser` or `nodejs`. This is relative elegant implementation comparing with `wasm loader` in `browser`(powered by webpack, vite or something else) or `fs` in `nodejs`.
+
+
+
+## License
+
+Distributed under the [Mulan Permissive Software License](LICENSE)