Forráskód Böngészése

docs: perfect README

Li4n0 6 éve
szülő
commit
748b106a3a
2 módosított fájl, 5 hozzáadás és 9 törlés
  1. 3 5
      README-zh_CN.md
  2. 2 4
      README.md

+ 3 - 5
README-zh_CN.md

@@ -1,11 +1,9 @@
 # Hugo Encryptor
 
-**Hugo-Encryptor** 是一款能够帮助作者保护文章内容的工具。它使用 AES-256 来对文章的内容进行加密,并且通过在文章中嵌入内联 `JavaScript` 代码来验证用户输入的密码是否正确。没有正确的文章密码,读者将无法看到文章的加密内容。
+**Hugo-Encryptor** 是一款能够帮助作者保护文章内容的工具。它使用 AES-256 来对文章的内容进行加密,并且通过在文章中嵌入内联 `JavaScript` 代码来验证读者输入的密码是否正确。没有正确的文章密码,读者将无法看到文章的加密内容。
 
 [English Document](./README.md)
 
-[TOC]
-
 ## 安装
 
 环境依赖:Python3
@@ -33,9 +31,9 @@ $ cp shortcodes/hugo-encryptor.html /path/to/your/blog/layouts/shortcodes/hugo-e
 
 ## 使用方法
 
-**步骤一:使用 `hugo-encryptor`  shortcode 标签包裹你需要加密的内容 **
+**步骤一:使用 `hugo-encryptor`  shortcode 标签包裹你需要加密的内容**
 
-**注意:在`hugo-encryptor` shortcode 标签之前必须存在一段明文文字以及 \<!--more--\> 标签 **
+**注意:在`hugo-encryptor` shortcode 标签之前必须存在一段明文文字以及 \<!--more--\> 标签**
 
 ```markdown
 ---

+ 2 - 4
README.md

@@ -4,8 +4,6 @@
 
 [中文文档](./README-zh_CN.md)
 
-[TOC]
-
 ## Installation
 
 Environmental dependence: Python3
@@ -89,11 +87,11 @@ For the difference of two storage ways:
 
 * **localStorage**:
 
-  Once a user input the correct password,the authorization status will not expire, the user can read the article at any time without having to enter the password again. Unless you change the password or the user clean his browser cache.
+  Once a reader input the correct password,the authorization status will not expire, the reader can read the article at any time without having to enter the password again. Unless you change the password or the reader clean his browser cache.
 
 * **sessionStorage**:
 
-  If a user input the correct password, he could read the article without having to enter the password again until the user close his browser.
+  If a reader input the correct password, he could read the article without having to enter the password again until the user close his browser.
 
 ### Style