Create FUNDING.yml

Update docs to add sponsor section
HenryQW · Jul 4, 2019 · b16922e · b16922e
1 parent abf061e
commit b16922e
Show file tree

Hide file tree

Showing 9 changed files with 117 additions and 76 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: Awesome-TTRSS
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -1,44 +1,44 @@
-<!--  
+<!--
 
 I'm sorry you have to come here, I understand your frustrations.
 Please complete the list of questions to save us both time.
 
 -->
 
-* ## _What_ is the issue?
+- ## _What_ is the issue?
 
 <!-- Ex. Immediately after I login, my computer burns down. -->
 
-* ## _What_ is your OS and its version?
+- ## _What_ is your OS and its version?
 
 <!-- Ex. Debian 9 -->
 
-* ## _What_ is your installation method?
+- ## _What_ is your installation method?
 
 <!-- Please keep only the selected option here -->
 
-* ### Docker
+- ### Docker
 
-  * Did you build your own dockerfile (paste it here if possible)?
+  - Did you build your own dockerfile (paste it here if possible)?
 
-* ### Old-fashion way
+- ### Old-fashion way
 
-  * _What_ is your setup? (PHP version, database used, etc.)
+  - _What_ is your setup? (PHP version, database used, etc.)
     <!-- From experience, most issues are related to PHP. -->
 
-* ### Others
+- ### Others
 
-* ## _Are_ there any error logs?
+- ## _Are_ there any error logs?
 
 <!--  Please paste it here if possible -->
 
-* ## _How_ can the issue be replicated?
+- ## _How_ can the issue be replicated?
 
 <!-- Please be as specific as possible. Create a list of steps if necessary. -->
 
-* ## Other Comments
+- ## Other Comments
 
-<!--  
+<!--
 
 I solemnly swear that **I have googled for solutions and the issue is unprecedented**.
 

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,14 +1,14 @@
 {
-    "cSpell.words": [
-        "Feediron",
-        "Feedly",
-        "Heroku",
-        "Reeder",
-        "TTRSS's",
-        "freestyler",
-        "fulltext",
-        "opencc",
-        "postgres",
-        "ttrss"
-    ]
-}
+  "cSpell.words": [
+    "Feediron",
+    "Feedly",
+    "Heroku",
+    "Reeder",
+    "TTRSS's",
+    "freestyler",
+    "fulltext",
+    "opencc",
+    "postgres",
+    "ttrss"
+  ]
+}
diff --git a/README.md b/README.md
@@ -8,10 +8,16 @@
 
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHenryQW%2FAwesome-TTRSS.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FHenryQW%2FAwesome-TTRSS?ref=badge_shield)
 
-[Tiny Tiny RSS](https://tt-rss.org/) is an open source RSS feed reader and aggregator written in PHP. 🐋 Awesome TTRSS aims to provide a powerful Dockerised all-in-one solution, with enhanced user experience via simplified deployment and a list of curated plugins.
+🐋 Awesome TTRSS aims to provide a powerful **Dockerized all-in-one** solution for [Tiny Tiny RSS](https://tt-rss.org/), an open source RSS feed reader and aggregator written in PHP, with enhanced user experience via simplified deployment and a list of curated plugins. You may sponsor Awesome TTRSS via its [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/).
 
-[Docs](https://ttrss.henry.wang)
+📖 [Docs](https://ttrss.henry.wang)
 
-[Tiny Tiny RSS](https://tt-rss.org/) 是一款基于 PHP 的免费开源 RSS 聚合阅读器。🐋 Awesome TTRSS 旨在提供一个「容器化」的 Tiny Tiny RSS 一站式解决方案，通过提供简易的部署方式以及一些额外插件，以提升用户体验。
+🐋 Awesome TTRSS 旨在提供一个「容器化」的 [Tiny Tiny RSS](https://tt-rss.org/)（一款基于 PHP 的免费开源 RSS 聚合阅读器）的一站式解决方案，通过提供简易的部署方式以及一些额外插件，以提升用户体验。您可以通过 Awesome TTRSS 的 [💰OpenCollective 页面](https://opencollective.com/Awesome-TTRSS/) 进行赞助。
 
-[文档](https://ttrss.henry.wang/zh/)
+📖 [文档](https://ttrss.henry.wang/zh/)
+
+## Donation 捐赠
+
+| PayPal                                                                                                                                                                       | 微信赞赏 WeChat Pay                                                 | OpenCollective                                                     |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [![paypal](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MTM5L6T4PHRQS&source=url) | <img src="https://share.henry.wang/IKaxAW/duFgAuOnmk+" width="200"> | [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/) |
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -53,6 +53,10 @@ module.exports = {
           {
             text: "首页",
             link: "/zh/"
+          },
+          {
+            text: "赞助",
+            link: "https://opencollective.com/Awesome-TTRSS/"
           }
         ]
       },
@@ -65,6 +69,10 @@ module.exports = {
           {
             text: "Home",
             link: "/"
+          },
+          {
+            text: "Sponsor",
+            link: "https://opencollective.com/Awesome-TTRSS/"
           }
         ]
       }

diff --git a/docs/README.md b/docs/README.md
@@ -8,11 +8,11 @@
 
 ## About
 
-[Tiny Tiny RSS](https://tt-rss.org/) is an open source RSS feed reader and aggregator written in PHP. 🐋 Awesome TTRSS aims to provide a powerful **Dockerised all-in-one** solution, with enhanced user experience via simplified deployment and a list of curated plugins.
+🐋 Awesome TTRSS aims to provide a powerful **Dockerized all-in-one** solution for [Tiny Tiny RSS](https://tt-rss.org/), an open source RSS feed reader and aggregator written in PHP, with enhanced user experience via simplified deployment and a list of curated plugins.
 
 ## Deployment
 
-**Support postgres only for a better user experience.** mysql support is dropped since [tag 3.5_mysql_php5](https://github.com/HenryQW/Awesome-TTRSS/tree/3.5_mysql_php5).
+A VPS is highly recommended to host your Awesome TTRSS instance, a VPS can be obtained from as little as \$5/month at [DigitalOcean](https://m.do.co/c/d6ef3c80105c). Alternatively, you may request for personalized support, fully-managed service or fully-managed VPS via sponsoring Awesome TTRSS on its [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/).
 
 ### Deployment via docker
 
@@ -47,14 +47,14 @@ docker run -it --name ttrss --restart=always \
 
 #### Supported Environment Variables
 
-* SELF_URL_PATH: the url to your TTRSS instance
-* DB_HOST: the address of your database
-* DB_PORT: the port of your database
-* DB_NAME: the name of your database
-* DB_USER: the user of your database
-* DB_PASS: the password of your database
-* ENABLE_PLUGINS: the plugins you'd like to enable at system level
-* SESSION_COOKIE_LIFETIME: the expiry time for your login session cookie in hours, default to 24 hours
+- SELF_URL_PATH: the url to your TTRSS instance
+- DB_HOST: the address of your database
+- DB_PORT: the port of your database
+- DB_NAME: the name of your database
+- DB_USER: the user of your database
+- DB_PASS: the password of your database
+- ENABLE_PLUGINS: the plugins you'd like to enable at system level
+- SESSION_COOKIE_LIFETIME: the expiry time for your login session cookie in hours, default to 24 hours
 
 ### Configure HTTPS
 
@@ -113,9 +113,9 @@ Fetch fulltext of articles via a self-hosted Mercury Parser API. A separate Merc
 #### Steps
 
 1. Enable `mercury-fulltext` plugin in preference
-    ![enable Mercury](https://share.henry.wang/92AGp5/x9xYB93cnX+)
+   ![enable Mercury](https://share.henry.wang/92AGp5/x9xYB93cnX+)
 1. Enter Mercury Parser API endpoint
-    ![enter Mercury Parser API endpoint](https://share.henry.wang/KFrzMD/O2xonuy9ta+)
+   ![enter Mercury Parser API endpoint](https://share.henry.wang/KFrzMD/O2xonuy9ta+)
 
 ### [Fever API](https://github.com/HenryQW/tinytinyrss-fever-plugin)
 
@@ -126,9 +126,9 @@ Provide Fever API simulate.
 #### Steps
 
 1. Enable API in preference
-    ![enable API](https://share.henry.wang/X2AnXi/bVVDg9mGDm+)
+   ![enable API](https://share.henry.wang/X2AnXi/bVVDg9mGDm+)
 1. Enter a password for Fever in preference
-    ![enter a Fever password](https://share.henry.wang/HspODo/xRSbZQheVN+)
+   ![enter a Fever password](https://share.henry.wang/HspODo/xRSbZQheVN+)
 1. In supported RSS readers, use `https://[your url]/plugins/fever` as the target server address, with your account and the password set in Step 2.
 1. The plugin communicates with TTRSS using an unsalted MD5 hash, [using HTTPS](#configure-https) is strongly recommended.
 
@@ -139,9 +139,9 @@ Conversion between Traditional and Simplified Chinese via [OpenCC](https://githu
 #### Steps
 
 1. Enable `opencc` plugin in preference
-    ![enable opencc](https://share.henry.wang/EvN5Nl/2RHNnMV2iP+)
+   ![enable opencc](https://share.henry.wang/EvN5Nl/2RHNnMV2iP+)
 1. Enter OpenCC API endpoint
-    ![enter OpenCC API endpoint](https://share.henry.wang/JdJeUB/vIsRBk3EXn+)
+   ![enter OpenCC API endpoint](https://share.henry.wang/JdJeUB/vIsRBk3EXn+)
 
 Demo instances, availability is not guaranteed: [https://opencc.henry.wang](https://opencc.henry.wang) or [http://opencc2.henry.wang](http://opencc2.henry.wang).
 
@@ -179,15 +179,22 @@ Refer to [Feediron](https://github.com/feediron/ttrss_plugin-feediron) for more
 
 ## Recommendation
 
-* [RSSHub](https://docs.rsshub.app/en/) is an interesting place for discovering RSS feeds.
-* For iOS and macOS user, the integrated [Fever plugin](https://github.com/HenryQW/tinytinyrss-fever-plugin) supplies [Reeder 4](http://reederapp.com/) backend support.
-* For Android user, the integrated [Fever plugin](https://github.com/HenryQW/tinytinyrss-fever-plugin) supplies [News+](http://github.com/noinnion/newsplus/) backend support.
-* For Linux user, the integrated [FeedReader API](https://github.com/jangernert/FeedReader/tree/master/data/tt-rss-feedreader-plugin) supplies [FeedReader](https://jangernert.github.io/FeedReader/) backend support.
+- [RSSHub](https://docs.rsshub.app/en/) is an interesting place for discovering RSS feeds.
+- For iOS and macOS user, the integrated [Fever plugin](https://github.com/HenryQW/tinytinyrss-fever-plugin) supplies [Reeder 4](http://reederapp.com/) backend support.
+- For Android user, the integrated [Fever plugin](https://github.com/HenryQW/tinytinyrss-fever-plugin) supplies [News+](http://github.com/noinnion/newsplus/) backend support.
+- For Linux user, the integrated [FeedReader API](https://github.com/jangernert/FeedReader/tree/master/data/tt-rss-feedreader-plugin) supplies [FeedReader](https://jangernert.github.io/FeedReader/) backend support.
 
 ## Support and Help
 
-* Read [this guide](https://henry.wang/2018/04/25/ttrss-docker-plugins-guide.html) might help.
-* Open an issue via [GitHub issue](https://github.com/HenryQW/Awesome-TTRSS/issues), I will try to respond ASAP.
+- You may request for personalized support via sponsoring Awesome TTRSS on its [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/).
+- Read [this guide](https://henry.wang/2018/04/25/ttrss-docker-plugins-guide.html) might help.
+- Open an issue via [GitHub issue](https://github.com/HenryQW/Awesome-TTRSS/issues).
+
+## Donation
+
+| PayPal                                                                                                                                                                       | WeChat Pay                                                          | OpenCollective                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| [![paypal](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MTM5L6T4PHRQS&source=url) | <img src="https://share.henry.wang/IKaxAW/duFgAuOnmk+" width="200"> | [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/) |
 
 ## License
 

diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -12,7 +12,7 @@
 
 ## 部署
 
-**为了更好的用户体验，此镜像仅支持 postgres 数据库。** 自 [tag 3.5_mysql_php5](https://github.com/HenryQW/Awesome-TTRSS/tree/3.5_mysql_php5) 起停止支持 mysql。
+推荐使用一台 VPS 来部署您的 Awesome TTRSS 实例，[DigitalOcean](https://m.do.co/c/d6ef3c80105c) 提供高性价比的 VPS 仅需 \$5/月。除此之外，通过 Awesome TTRSS 的 [💰OpenCollective 页面](https://opencollective.com/Awesome-TTRSS/) 进行赞助，即可获得定制支持，全托管服务，全托管 VPS 等私人服务。
 
 ### 通过 Docker 部署
 
@@ -47,14 +47,14 @@ docker run -it --name ttrss --restart=always \
 
 ### 支持的环境变量列表
 
-* SELF_URL_PATH: TTRSS 实例地址
-* DB_HOST: 数据库地址
-* DB_PORT: 数据库端口
-* DB_NAME: 数据库名字
-* DB_USER: 数据库用户名
-* DB_PASS: 数据库密码
-* ENABLE_PLUGINS: 在系统层面启用的插件名称，其中 `auth_internal` 为必须启用的登录插件
-* SESSION_COOKIE_LIFETIME: 使用网页版登陆时 cookie 过期时间，单位为小时，默认为 24 小时
+- SELF_URL_PATH: TTRSS 实例地址
+- DB_HOST: 数据库地址
+- DB_PORT: 数据库端口
+- DB_NAME: 数据库名字
+- DB_USER: 数据库用户名
+- DB_PASS: 数据库密码
+- ENABLE_PLUGINS: 在系统层面启用的插件名称，其中 `auth_internal` 为必须启用的登录插件
+- SESSION_COOKIE_LIFETIME: 使用网页版登陆时 cookie 过期时间，单位为小时，默认为 24 小时
 
 ### 配置 HTTPS
 
@@ -113,9 +113,9 @@ server {
 #### 设置步骤
 
 1. 在设置中启用 `mercury-fulltext` 插件
-    ![启用 Mercury](https://share.henry.wang/92AGp5/x9xYB93cnX+)
+   ![启用 Mercury](https://share.henry.wang/92AGp5/x9xYB93cnX+)
 1. 在设置中填入 Mercury Parser API 地址
-    ![填入 Mercury Parser API 地址](https://share.henry.wang/KFrzMD/O2xonuy9ta+)
+   ![填入 Mercury Parser API 地址](https://share.henry.wang/KFrzMD/O2xonuy9ta+)
 
 ### [Fever API](https://github.com/HenryQW/tinytinyrss-fever-plugin)
 
@@ -126,10 +126,10 @@ server {
 #### 设置步骤
 
 1. 在设置中启用 API。
-    ![启用 API](https://share.henry.wang/X2AnXi/bVVDg9mGDm+)
+   ![启用 API](https://share.henry.wang/X2AnXi/bVVDg9mGDm+)
 1. 在插件设置中设置 Fever 密码。
-    ![设置 Fever 密码](https://share.henry.wang/HspODo/xRSbZQheVN+)
-1. 在支持 Fever 的阅读器用，使用 `https://[你的地址]/plugins/fever` 作为服务器地址。使用你的账号和步骤 2 中的密码登录。
+   ![设置 Fever 密码](https://share.henry.wang/HspODo/xRSbZQheVN+)
+1. 在支持 Fever 的阅读器用，使用 `https://[您的地址]/plugins/fever` 作为服务器地址。使用您的账号和步骤 2 中的密码登录。
 1. 由于该插件使用未加盐的 MD5 加密密码进行通信，强烈建议[开启 HTTPS](#配置-https)。
 
 ### [OpenCC 繁简转换](https://github.com/HenryQW/ttrss_opencc)
@@ -139,9 +139,9 @@ server {
 #### 设置步骤
 
 1. 在设置中启用 `opencc` 插件
-    ![启用 opencc](https://share.henry.wang/EvN5Nl/2RHNnMV2iP+)
+   ![启用 opencc](https://share.henry.wang/EvN5Nl/2RHNnMV2iP+)
 1. 在设置中填入 OpenCC API 地址
-    ![填入 OpenCC API 地址](https://share.henry.wang/JdJeUB/vIsRBk3EXn+)
+   ![填入 OpenCC API 地址](https://share.henry.wang/JdJeUB/vIsRBk3EXn+)
 
 Demo 服务器，可用性不做任何保证：[https://opencc.henry.wang](https://opencc.henry.wang) or [http://opencc2.henry.wang](http://opencc2.henry.wang)。
 
@@ -179,14 +179,21 @@ Demo 服务器，可用性不做任何保证：[https://opencc.henry.wang](https
 
 ## 使用建议
 
-* 推荐使用 [RSSHub](https://docs。rsshub。app/) 来发现更多有趣的订阅源。
-* 对于 iOS 和 macOS 用户，内置的 [Fever API 模拟插件](#fever-api) 提供 [Reeder 4](http://reederapp.com/) 后端支持。
-* 对于 Linux 用户，内置的 [FeedReader API](#feedreader-api) 提供 [FeedReader](https://jangernert.github.io/FeedReader/) 后端支持。
+- 推荐使用 [RSSHub](https://docs。rsshub。app/) 来发现更多有趣的订阅源。
+- 对于 iOS 和 macOS 用户，内置的 [Fever API 模拟插件](#fever-api) 提供 [Reeder 4](http://reederapp.com/) 后端支持。
+- 对于 Linux 用户，内置的 [FeedReader API](#feedreader-api) 提供 [FeedReader](https://jangernert.github.io/FeedReader/) 后端支持。
 
 ## 支持与帮助
 
-* 阅读此[指南](https://henry.wang/2018/04/25/ttrss-docker-plugins-guide.html)可能会有帮助。
-* 通过 [GitHub issue](https://github.com/HenryQW/Awesome-TTRSS/issues) 提交问题，我会尽快答复。
+- 通过 Awesome TTRSS 的 [💰OpenCollective 页面](https://opencollective.com/Awesome-TTRSS/) 进行赞助，即可获得私人定制支持。
+- 阅读此[指南](https://henry.wang/2018/04/25/ttrss-docker-plugins-guide.html)可能会有帮助。
+- 通过 [GitHub issue](https://github.com/HenryQW/Awesome-TTRSS/issues) 提交问题。
+
+## 捐赠
+
+| PayPal                                                                                                                                                                       | 微信赞赏                                                            | OpenCollective                                                     |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [![paypal](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MTM5L6T4PHRQS&source=url) | <img src="https://share.henry.wang/IKaxAW/duFgAuOnmk+" width="200"> | [💰OpenCollective page](https://opencollective.com/Awesome-TTRSS/) |
 
 ## 许可
 

diff --git a/package.json b/package.json
@@ -7,11 +7,12 @@
   "private": true,
   "scripts": {
     "dev": "vuepress dev docs",
-    "docs:build": "vuepress build docs"
+    "docs:build": "vuepress build docs",
+    "format": "prettier \"**/*.{js,json,md}\" --write"
   },
   "devDependencies": {
     "@vuepress/plugin-back-to-top": "1.0.2",
     "@vuepress/plugin-google-analytics": "1.0.2",
     "vuepress": "1.0.2"
   }
-}
+}
diff --git a/renovate.json b/renovate.json
@@ -3,4 +3,4 @@
     "config:base"
   ],
   "includeForks": true
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,4 +3,4 @@ @@
         "config:base"
       ],
       "includeForks": true
-    }
+    }