half rebrand the README
This commit is contained in:
parent
9133062e68
commit
92afbe55de
30
README.md
30
README.md
@ -1,20 +1,10 @@
|
|||||||
# Redlib
|
<img align="left" width="128" height="128" src="https://git.stardust.wtf/attachments/842086e3-b718-4379-b718-c3a542842152" alt="logo">
|
||||||
|
|
||||||
> An alternative private front-end to Reddit, with its origins in [Libreddit](https://github.com/libreddit/libreddit).
|
# Redsunlib
|
||||||
|
> An alternative private front-end to Reddit, a fork of [Redlib](https://github.com/redlib-org/redlib) with some function and cosmetic changes.
|
||||||
|
|
||||||
![screenshot](https://i.ibb.co/QYbqTQt/libreddit-rust.png)
|
![screenshot](https://i.ibb.co/QYbqTQt/libreddit-rust.png)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**10-second pitch:** Redlib is a private front-end like [Invidious](https://github.com/iv-org/invidious) but for Reddit. Browse the coldest takes of [r/unpopularopinion](https://redlib.matthew.science/r/unpopularopinion) without being [tracked](#reddit).
|
|
||||||
|
|
||||||
- 🚀 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
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
1. [Redlib](#redlib)
|
1. [Redlib](#redlib)
|
||||||
@ -30,7 +20,6 @@
|
|||||||
- [Reddit](#reddit)
|
- [Reddit](#reddit)
|
||||||
- [Redlib](#redlib-1)
|
- [Redlib](#redlib-1)
|
||||||
- [Server](#server)
|
- [Server](#server)
|
||||||
- [Official instance (redlib.matthew.science)](#official-instance-redlibmatthewscience)
|
|
||||||
5. [Deployment](#deployment)
|
5. [Deployment](#deployment)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
- [Docker Compose](#docker-compose)
|
- [Docker Compose](#docker-compose)
|
||||||
@ -61,9 +50,6 @@ For information on instance uptime, see the [Uptime Robot status page](https://s
|
|||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> Find Redlib on 💬 [Matrix](https://matrix.to/#/#redlib:matrix.org), 🐋 [Quay.io](https://quay.io/repository/redlib/redlib), :octocat: [GitHub](https://github.com/redlib-org/redlib), and 🦊 [GitLab](https://gitlab.com/redlib/redlib).
|
|
||||||
|
|
||||||
Redlib hopes to provide an easier way to browse Reddit, without the ads, trackers, and bloat. Redlib was inspired by other alternative front-ends to popular services such as [Invidious](https://github.com/iv-org/invidious) for YouTube, [Nitter](https://github.com/zedeus/nitter) for Twitter, and [Bibliogram](https://sr.ht/~cadence/bibliogram/) for Instagram.
|
Redlib hopes to provide an easier way to browse Reddit, without the ads, trackers, and bloat. Redlib was inspired by other alternative front-ends to popular services such as [Invidious](https://github.com/iv-org/invidious) for YouTube, [Nitter](https://github.com/zedeus/nitter) for Twitter, and [Bibliogram](https://sr.ht/~cadence/bibliogram/) for Instagram.
|
||||||
|
|
||||||
Redlib currently implements most of Reddit's (signed-out) functionalities but still lacks [a few features](https://github.com/redlib-org/redlib/issues).
|
Redlib currently implements most of Reddit's (signed-out) functionalities but still lacks [a few features](https://github.com/redlib-org/redlib/issues).
|
||||||
@ -158,16 +144,6 @@ For transparency, I hope to describe all the ways Redlib handles user privacy.
|
|||||||
|
|
||||||
- **Cookies:** Redlib uses optional cookies to store any configured settings in [the settings menu](https://redlib.matthew.science/settings). These are not cross-site cookies and the cookies hold no personal data.
|
- **Cookies:** Redlib uses optional cookies to store any configured settings in [the settings menu](https://redlib.matthew.science/settings). These are not cross-site cookies and the cookies hold no personal data.
|
||||||
|
|
||||||
#### Official instance (redlib.matthew.science)
|
|
||||||
|
|
||||||
The official instance is hosted at https://redlib.matthew.science.
|
|
||||||
|
|
||||||
- **Server:** The official instance runs a production binary, and thus logs nothing.
|
|
||||||
|
|
||||||
- **DNS:** The domain for the official instance uses Cloudflare as the DNS resolver. However, this site is not proxied through Cloudflare, and thus Cloudflare doesn't have access to user traffic.
|
|
||||||
|
|
||||||
- **Hosting:** The official instance is 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.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Deployment
|
# Deployment
|
||||||
|
Loading…
Reference in New Issue
Block a user