update README

Author: exiledkingcc

README.md

@@ -1,7 +1,10 @@
 # zcrypto
+
+**English** | [**中文**](./README.zh.md)
+
 a minimal crypto lib for limited environment like MCU.
 
-*features*:
+## features
 * base64
 * hash
     * SM3
@@ -18,23 +21,20 @@ a minimal crypto lib for limited environment like MCU.
     * OFB
 * asymmetric key encryption
     * RSA(2048)
+    * RSA-OAEP(2048)
 
 ## block cipher
-* crypto algorithm:
-    * AES(128, 192, 256)
-    * SM4
-* operation mode:
-    * ECB
-    * CBC
-    * CFB
-    * OFB
 
-api has two styles:
-* `aes_{keylen}_{mode}_{en/de}crypt` / `sm4_{mode}_{en/de}crypt`
-* `aes_{en/de}crypt(aes_ctx_t*, ...)` / `sm4_{en/de}crypt(sm4_ctx_t*, ...)`
+do encryption or decryption in once function call.
+* `aes_{keylen}_{mode}_{en/de}crypt`
+* `sm4_{mode}_{en/de}crypt`
+
+or use context:
+* `aes_{en/de}crypt(aes_ctx_t*, ...)`
+* `sm4_{en/de}crypt(sm4_ctx_t*, ...)`
 
-the first style api do **only once** encryption or decryption. but for the second style api,
-you can call `{aes/sm4}_{en/de}crypt` multiple times and to encryption(decryption) for stream data.
+you can call `{aes/sm4}_{en/de}crypt` multiple times
+to encrypt or decrypt for stream data.
 
 for both two style apis, you should do the padding yourself, and make sure the input data length
 **exactly** multiple of the block size (aka 16bytes).

README.zh.md

@@ -1,35 +1,54 @@
 # zcrypto
+
+**中文** | [**English**](./README.md)
+
 一个为受限环境（比如STM32）写的加密相关操作的库。
 
-*支持功能*:
+## 支持功能:
 * base64
-* hash
+* 散列函数
     * SM3
     * MD5
     * SHA1
     * SHA256
-* block cipher algorithm
+* 分组密码算法
     * AES(128, 192, 256)
     * SM4
-* block cipher mode
+* 分组密码模式
     * ECB
     * CBC
     * CFB
     * OFB
-* asymmetric key encryption
+* 非对称加密算法
     * RSA(2048)
+    * RSA-OAEP(2048)
 
 ## 分组密码
 
-支持：AES（192、169，256）， SM4，模式支持ECB，CBC，CFB，OFB。
-支持两种风格的API。一种是：`aes_{keylen}_{mode}_{en/de}crypt`和`sm4_{mode}_{en/de}crypt`，这是做一次性加密（解密）的。
-另一种是`aes_{en/de}crypt(aes_ctx_t*, ...)`和`sm4_{en/de}crypt(sm4_ctx_t*, ...)`，这种可以调用多次，
-对流数据进行加密（解密）。具体使用请看`test/test_{aes/sm4}.c`。
+使用单一加解密函数：
+* `aes_{keylen}_{mode}_{en/de}crypt`
+* `sm4_{mode}_{en/de}crypt`
+
+或者使用多次调用的函数:
+* `aes_{en/de}crypt(aes_ctx_t*, ...)`
+* `sm4_{en/de}crypt(sm4_ctx_t*, ...)`
+
+可以多次调用`{aes/sm4}_{en/de}crypt`，方便用于流式数据的加解密。
+
+具体使用请看`test/test_{aes/sm4}.c`。
 
 ## HASH算法
 
-支持SM3，MD5，SHA1，SHA256。使用`{alg}_init`初始化，使用`{alg}_update`更新数据，使用`{alg}_[hex]digest`输出hash值。
-可以在任意时候调用`{alg}_[hex]digest`获取当前数据的hash值。但是需要保证结果的空间足够存hash值。具体使用请看`test/test_hash.c`。
+支持SM3，MD5，SHA1，SHA256。
+
+使用方法：
+* 使用`{alg}_init`初始化
+* 使用`{alg}_update`更新数据
+* 使用`{alg}_[hex]digest`输出hash值。
+
+可以在任意时候调用`{alg}_[hex]digest`获取当前数据的hash值。但是需要保证结果的空间足够存hash值。
+
+具体使用请看`test/test_hash.c`。
 
 ## 非对称密钥算法
 
@@ -40,4 +59,12 @@
 使用`./test/rsa_naive_test.py | ./build/test_rsa.elf`进行测试。
 
 使用`rsa_pub_oaep_encrypt`进行`RSAES-OAEP`运算，请参考[RFC8017](https://tools.ietf.org/html/rfc8017#section-7.1)。
-具体使用请看`test/test_oaep.c`。 使用`./test/rsa_oaep_test.py gen | ./build/test_oaep.elf | ./test/rsa_oaep_test.py verify`进行测试。
+
+具体使用请看`test/test_oaep.c`。 
+
+测试:
+```
+./test/rsa_oaep_test.py gen | 
+    ./build/test_oaep.elf | 
+    ./test/rsa_oaep_test.py verify
+```