From 91a08c63bb07c4ff75579d80a9a1d8021e0c0cf2 Mon Sep 17 00:00:00 2001
From: Mivinci <1366723936@qq.com>
Date: Thu, 17 Feb 2022 19:55:29 +0800
Subject: [PATCH] docs

---
 README.md               | 22 ++++++++++++++++++++--
 docs/README_CN.md       | 18 +++++++++++++++++-
 exampleSite/config.toml |  2 +-
 3 files changed, 38 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3daf2ec..c56a43c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
 # Minima
 
-A Hugo port of [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). [Demo site](https://h.xjj.pub/).
+This project was originally a Hugo port of the [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). A lot of changes have been made so far to make Minima cooler.
+
+
+Links: [Demo Site](https://h.xjj.pub/), [Demo Configs](../exampleSite/), [Author's Blog](https://xjj.pub)
+
 
 > The main branch is in development stage, UI or configuration may vary. You can use the latest stable version [here](https://github.com/Mivinci/hugo-theme-minima/releases/tag/v1.1.0).
 
@@ -17,6 +21,7 @@ A Hugo port of [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima).
 - [x] Disqus/Utterances
 - [x] Optional ToC
 - [x] External link post
+- [x] RSS
 
 ## Usage
 
@@ -76,7 +81,20 @@ link: https://gohugo.io
 ---
 ```
 
-And when you click the title in the list page, you will be redireted to https://gohugo.io which's 🆒.
+And when you click the title in the list page, you will be redireted to https://gohugo.io, which's 🆒.
+
+### RSS Feeds
+
+v1.1.0 and later versions support subscription to external RSS feeds whereas titles and links to your friends' posts can be displayed in your blog site. For details, see `friends` in the [configuaration](./exampleSite/config.toml)
+
+**Example**
+
+```yaml
+[params.friends]
+feeds = ["https://xjj.pub/index.xml"]
+topk = 3
+title = "Friends' Posts"
+```
 
 ### Feedback
 
diff --git a/docs/README_CN.md b/docs/README_CN.md
index eec2459..cd69634 100644
--- a/docs/README_CN.md
+++ b/docs/README_CN.md
@@ -1,6 +1,8 @@
 # Minima
 
-Minima 是个简洁但功能完整的 Hugo 主题，是 [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima) 的 Hugo 版本，但对其界面做了些调整，也添加了些功能.。示例网页：[h.xjj.pub](https://h.xjj.pub/)，或直接查看作者的博客网站：[xjj.pub](https://xjj.pub)。
+Minima 是个简洁但功能完整的 Hugo 主题，原本是 [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima) 主题的 Hugo 版本，现在已经在其设计行上做了多处调整，和添加新的功能。
+
+链接：[示例网页](https://h.xjj.pub/)，[示例配置](../exampleSite/config.toml)，[作者博客](https://xjj.pub)
 
 ![screenshot](../images/tn.png)
 
@@ -15,6 +17,7 @@ Minima 是个简洁但功能完整的 Hugo 主题，是 [Hexo Minima](https://gi
 - [x] 文章目录
 - [x] 分类、标签、专栏
 - [x] 外部链接 
+- [x] RSS
 
 ## 使用
 
@@ -84,6 +87,19 @@ link: https://gohugo.io
 
 当点击改文章题目时，会跳转到设置的链接地址 https://gohugo.io，🆒
 
+### RSS Feeds
+
+v1.1.0 版本之后，Minima 支持订阅 RSS Feeds，因此你可以用来在自己的博客上显示别人的文章标题和链接。详情见 [示例配置](./exampleSite/config.toml) 的 `friends` 部分。
+
+**示例**
+
+```yaml
+[params.friends]
+feeds = ["https://xjj.pub/index.xml"]
+topk = 3
+title = "Friends' Posts"
+```
+
 ### 反馈
 
 欢迎在 [issues](https://github.com/Mivinci/hugo-theme-minima/issues) 下留言，或将问题详细描述发送到我的邮箱：i@xjj.pub
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 85b3215..6aa8c38 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -105,7 +105,7 @@ svg = ""
 feeds = ["https://xjj.pub/index.xml"]
 topk = 3
 title = "Friends' Posts"
-
+proxy = "" # reserved
 
 
 # Menu.main is an array that's used to decide what entries can be shown