feat: perfect the README

palp1tate · Sep 23, 2023 · 54445df · 54445df
1 parent effbe95
commit 54445df
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -59,6 +59,12 @@ Algorithms supported:
 - [Blake2b](https://en.wikipedia.org/wiki/Comparison_of_cryptographic_hash_functions)
 - [Blake2s](https://en.wikipedia.org/wiki/Comparison_of_cryptographic_hash_functions)
 
+The format of the`password` is same as the encryption algorithm format that comes with [Django](https://www.djangoproject.com/):
+
+```go
+<algorithm>$<iterations>$<salt>$<hash>
+```
+
 ## Installation
 
 ```

diff --git a/README_CN.md b/README_CN.md
@@ -25,17 +25,18 @@
     <a href=https://goreportcard.com/report/github.com/palp1tate/go-crypto-guard>
         <img src="https://goreportcard.com/badge/github.com/palp1tate/go-crypto-guard" alt="go report">
     </a>
-    <span>
+    <a href="#">
       <img src="https://img.shields.io/github/languages/top/palp1tate/go-crypto-guard" alt="language">
-    </span>
-    <span>
+    </a>
+    <a href="#">
       <img src="https://img.shields.io/github/last-commit/palp1tate/go-crypto-guard" alt="last commit">
-    </span>
-   <span>
+    </a>
+   <a href="#">
       <img src="https://komarev.com/ghpvc/?username=go-crypto-guard&label=Views&color=0e75b6&style=flat" alt="访问量统计" />
-    </span>
+    </a>
 </div>
 
+
 ## 介绍
 
 该存储库包含一个用 Go 编写的综合密码哈希库。该库支持多种哈希算法，包括 PBKDF2（使用 SHA1、SHA256、SHA384、SHA512 和 MD5）、Bcrypt、Scrypt、Argon2、HMAC、Blake2b 和 Blake2s。它允许自定义盐长度、迭代、密钥长度和算法选择。该开源项目旨在为开发人员提供用于安全密码存储和验证的多功能工具。
@@ -54,6 +55,12 @@
 - [Blake2b](https://en.wikipedia.org/wiki/Comparison_of_cryptographic_hash_functions)
 - [Blake2s](https://en.wikipedia.org/wiki/Comparison_of_cryptographic_hash_functions)
 
+password的格式与[Django](https://www.djangoproject.com/)内置的加密算法格式相同:
+
+```go
+<algorithm>$<iterations>$<salt>$<hash>
+```
+
 ## 安装
 
 ```