From aec45311cc803a551c51bd0dcf9bf374ec8fb0d1 Mon Sep 17 00:00:00 2001 From: Walkx Date: Wed, 6 Apr 2022 20:24:10 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=8D=EF=B8=8Ffix:=20Tries=20to=20add=20bet?= =?UTF-8?q?ter=20readability=20-=20=E2=9E=A1=EF=B8=8F=20fix:=20Moves=20fun?= =?UTF-8?q?ding=20links=20to=20correct=20file=20(#477)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * ✍️ fix(readme): Adds better readability * ➡️ fix(buymeacoffee): Moves custom link to correct FUNDING.yml * ➡️ fix(buymeacoffee): Moves custom link to correct FUNDING.yml * ✍️ fix(bugreport): Adds better readability * ✍️ fix(featureparity): Adds better readability * ✍️ fix(featurerequest): Adds better readability * ✍️ fix(crypto): Removes broken linking, changed to codeblock --- .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- .github/ISSUE_TEMPLATE/feature_parity.md | 6 +++--- .github/ISSUE_TEMPLATE/feature_request.md | 6 +++--- FUNDING.yml | 12 ------------ README.md | 14 +++++++------- 6 files changed, 18 insertions(+), 29 deletions(-) delete mode 100644 FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 5346ceb..5723180 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1,2 @@ liberapay: spike +custom: ['https://www.buymeacoffee.com/spikecodes'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 12ff5c5..03d38d1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: 🐛 Bug report about: Create a report to help us improve -title: '' +title: '🐛 Bug Report: ' labels: bug assignees: '' @@ -12,7 +12,7 @@ assignees: '' A clear and concise description of what the bug is. --> -## To reproduce +## Steps to reproduce the bug -## Expected behavior +## What's the expected behavior? -## Additional context +## Additional context / screenshot diff --git a/.github/ISSUE_TEMPLATE/feature_parity.md b/.github/ISSUE_TEMPLATE/feature_parity.md index 95bc729..22b9bd8 100644 --- a/.github/ISSUE_TEMPLATE/feature_parity.md +++ b/.github/ISSUE_TEMPLATE/feature_parity.md @@ -1,7 +1,7 @@ --- name: ✨ Feature parity about: Suggest implementing a feature into Libreddit that is found in Reddit.com -title: '' +title: '✨ Feature parity: ' labels: feature parity assignees: '' @@ -12,7 +12,7 @@ assignees: '' A clear and concise description of what the feature is. --> -## Describe the implementation into Libreddit +## Describe how this could be implemented into Libreddit @@ -22,7 +22,7 @@ assignees: '' A clear and concise description of any alternative solutions or features you've considered. --> -## Additional context +## Additional context / screenshot diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5d21fed..e9e6d31 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: 💡 Feature request about: Suggest a feature for Libreddit that is not found in Reddit -title: '' +title: '💡 Feature request: ' labels: enhancement assignees: '' @@ -12,7 +12,7 @@ assignees: '' A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> -## Describe the solution you'd like +## Describe the feature you would like to be implemented @@ -22,7 +22,7 @@ assignees: '' A clear and concise description of any alternative solutions or features you've considered. --> -## Additional context +## Additional context / screenshot diff --git a/FUNDING.yml b/FUNDING.yml deleted file mode 100644 index 49fc1ba..0000000 --- a/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# 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: # Replace with a single Open Collective username -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: spike -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: ['https://www.buymeacoffee.com/spikecodes'] diff --git a/README.md b/README.md index 356028f..79570d3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ **10 second pitch:** Libreddit is a portmanteau of "libre" (meaning freedom) and "Reddit". It is a private front-end like [Invidious](https://github.com/iv-org/invidious) but for Reddit. Browse the coldest takes of [r/unpopularopinion](https://libreddit.spike.codes/r/unpopularopinion) without being [tracked](#reddit). -- 🚀 Fast: written in Rust for blazing fast speeds and memory safety +- 🚀 Fast: written in Rust for blazing-fast speeds and memory safety - ☁️ Light: no JavaScript, no ads, no tracking, no bloat - 🕵 Private: all requests are proxied through the server, including media - 🔒 Secure: strong [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) prevents browser requests to Reddit @@ -21,9 +21,9 @@ I appreciate any donations! Your support allows me to continue developing Libred Donate using Liberapay -**Bitcoin:** [bc1qwyxjnafpu3gypcpgs025cw9wa7ryudtecmwa6y](bitcoin:bc1qwyxjnafpu3gypcpgs025cw9wa7ryudtecmwa6y) +**Bitcoin:** `bc1qwyxjnafpu3gypcpgs025cw9wa7ryudtecmwa6y` -**Monero:** [45FJrEuFPtG2o7QZz2Nps77TbHD4sPqxViwbdyV9A6ktfHiWs47UngG5zXPcLoDXAc8taeuBgeNjfeprwgeXYXhN3C9tVSR](monero:45FJrEuFPtG2o7QZz2Nps77TbHD4sPqxViwbdyV9A6ktfHiWs47UngG5zXPcLoDXAc8taeuBgeNjfeprwgeXYXhN3C9tVSR) +**Monero:** `45FJrEuFPtG2o7QZz2Nps77TbHD4sPqxViwbdyV9A6ktfHiWs47UngG5zXPcLoDXAc8taeuBgeNjfeprwgeXYXhN3C9tVSR` --- @@ -98,7 +98,7 @@ Feel free to [open an issue](https://github.com/spikecodes/libreddit/issues/new) | [libreddit.lqs5fjmajyp7rvp4qvyubwofzi6d4imua7vs237rkc4m5qogitqwrgyd.onion](http://libreddit.lqs5fjmajyp7rvp4qvyubwofzi6d4imua7vs237rkc4m5qogitqwrgyd.onion/) | 🇨🇦 CA | | | [libreddit.lunar.icu](https://libreddit.lunar.icu) | 🇩🇪 DE | ✅ | -A checkmark in the "Cloudflare" category here refers to the use of the reverse proxy, [Cloudflare](https://cloudflare). The checkmark will not be listed for a site which uses Cloudflare DNS but rather the proxying service which grants Cloudflare the ability to monitor traffic to the website. +A checkmark in the "Cloudflare" category here refers to the use of the reverse proxy, [Cloudflare](https://cloudflare). The checkmark will not be listed for a site that uses Cloudflare DNS but rather the proxying service which grants Cloudflare the ability to monitor traffic to the website. --- @@ -161,7 +161,7 @@ Results from Google Lighthouse ([Libreddit Report](https://lighthouse-dot-webdot - The requested URL - Search terms -**Location:** The same privacy policy goes on to describe location data may be collected through the use of: +**Location:** The same privacy policy goes on to describe that location data may be collected through the use of: - GPS (consensual) - Bluetooth (consensual) - Content associated with a location (consensual) @@ -185,7 +185,7 @@ For transparency, I hope to describe all the ways Libreddit handles user privacy **Cookies:** Libreddit uses optional cookies to store any configured settings in [the settings menu](https://libreddit.spike.codes/settings). These are not cross-site cookies and the cookies hold no personal data. -**Hosting:** The official instances are hosted on [Replit](https://replit.com/) which monitors usage to prevent abuse. I can understand if this invalidates certain users' threat models and therefore, selfhosting, using unofficial instances and browsing through Tor are welcomed. +**Hosting:** The official instances are hosted on [Replit](https://replit.com/) which monitors usage to prevent abuse. I can understand if this invalidates certain users' threat models and therefore, self-hosting, using unofficial instances, and browsing through Tor are welcomed. --- @@ -276,7 +276,7 @@ LIBREDDIT_DEFAULT_WIDE=on LIBREDDIT_DEFAULT_THEME=dark libreddit -r ## Proxying using NGINX -**NOTE** If you're [proxying Libreddit through a NGINX Reverse Proxy](https://github.com/spikecodes/libreddit/issues/122#issuecomment-782226853), add +**NOTE** If you're [proxying Libreddit through an NGINX Reverse Proxy](https://github.com/spikecodes/libreddit/issues/122#issuecomment-782226853), add ```nginx proxy_http_version 1.1; ```