Update docs

yifeikong · May 13, 2024 · f288142 · f288142
1 parent 22375f6
commit f288142
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/README-zh.md b/README-zh.md
@@ -20,8 +20,7 @@ TLS/JA3 和 HTTP/2 指纹。如果你莫名其妙地被某个网站封锁了，
 还提供了一个监控面板，让你能够随时观察抓取成功率。
 
 如果你在寻找云端托管 `curl_cffi` 服务的话，Scrapfly 是一个不错的选择。如果你希望自己管理
-脚本，他们还提供了一个[工具](https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi)，
-可以把 curl 命令直接转换成 `curl_cffi` 的 Python 代码。
+脚本，他们还提供了一个[curl 转 Python 的工具](https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi)。
 
 ------
 

diff --git a/README.md b/README.md
@@ -27,9 +27,8 @@ observability by providing an analytical dashboard and measuring the success rat
 rate in detail.
 
 Scrapfly is a good solution if you are looking for a cloud-managed solution for `curl_cffi`.
-If you are managing TLS/HTTP fingerprint by yourself with `curl_cffi`, they also maintain
-[this tool](https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi) to convert curl
-command into python curl_cffi code!
+If you are managing TLS/HTTP fingerprint by yourself with `curl_cffi`, they also maintain a
+[curl to python converter] (https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi).
 
 ------
 
@@ -224,3 +223,18 @@ the box on all subscription plans.
 ## Sponsor
 
 <a href="https://buymeacoffee.com/yifei" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
+## Citation
+
+If you find this project useful, please cite it as below:
+
+```
+@software{Kong2023,
+  author = {Yifei Kong},
+  title = {curl_cffi - A Python HTTP client for impersonating browser TLS and HTTP/2 fingerprints},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  url = {https://github.com/yifeikong/curl_cffi},
+}
+```
diff --git a/docs/index.rst b/docs/index.rst
@@ -48,8 +48,7 @@ rate in details.
 
 Scrapfly is a good solution if you are looking for a cloud-managed solution for ``curl_cffi``.
 If you are managing TLS/HTTP fingerprint by yourself with ``curl_cffi``, they also maintain
-`this tool <https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi>`_ to convert curl
-command into python curl_cffi code!
+a `curl to python converter <https://scrapfly.io/web-scraping-tools/curl-python/curl_cffi>`_ .
 
 ------