iridium/redsunlib
iridium/redsunlib
2
2
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases 4 Wiki Activity

fix README.md

Browse Source
This commit is contained in:
Ayaka 2024-06-28 00:32:20 +12:00
parent e984646ae6
commit f0eb496d6a
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,7 +1,7 @@
<img align="left" width="128" height="128" src="https://git.stardust.wtf/attachments/842086e3-b718-4379-b718-c3a542842152" alt="logo"> <img align="left" width="128" height="128" src="https://git.stardust.wtf/attachments/842086e3-b718-4379-b718-c3a542842152" alt="logo">
# Redsunlib # Redsunlib
> An alternative private front-end to Reddit, a fork of [Redlib](https://github.com/redlib-org/redlib) with some <sub><sup>(minor)</sub></sub> function and cosmetic changes. > An alternative private front-end to Reddit, a fork of [Redlib](https://github.com/redlib-org/redlib) with some <sup><sub>(minor)</sub></sup> function and cosmetic changes.
<br> <br>
@ -9,7 +9,7 @@
### Disclaimer ### Disclaimer
There are rapid changes/features in this fork that can(will) change without notice. If you want to host this version, be aware that it's likely to break at some point. I still wouldn't recommend it in a production environment unless you know what you're doing. Or like living on the edge....... There are rapid changes/features in this fork that can<sup>(will)</sup> change without notice. If you want to host this version, be aware that it's likely to break at some point. I still wouldn't recommend it in a production environment unless you know what you're doing. Or like living on the edge.......
> I would also like to thank the maintainers and contributors of both [Redlib](https://github.com/redlib-org/redlib) and [Libreddit](https://github.com/libreddit/libreddit) for all the work they did while I just added some low quality tacky features. ❤️ > I would also like to thank the maintainers and contributors of both [Redlib](https://github.com/redlib-org/redlib) and [Libreddit](https://github.com/libreddit/libreddit) for all the work they did while I just added some low quality tacky features. ❤️
@ -18,27 +18,28 @@ There are rapid changes/features in this fork that can(will) change without noti
## Table of Contents ## Table of Contents
1. [Redsunlib](#redsunlib) 1. [Redsunlib](#redsunlib)
- [Disclaimer](#disclaimer) - [Disclaimer](#disclaimer)
2. [Instances](#instances) 2. [Table of Contents](#table-of-contents)
3. [About](#about) 3. [Instances](#instances)
4. [About](#about)
- [The Name](#the-name) - [The Name](#the-name)
- [Built with](#built-with) - [Built with](#built-with)
- [How is it different from other Reddit front ends?](#how-is-it-different-from-other-reddit-front-ends) - [How is it different from other Reddit front ends?](#how-is-it-different-from-other-reddit-front-ends)
- [Teddit](#teddit) - [Teddit](#teddit)
- [Libreddit](#libreddit) - [Libreddit](#libreddit)
4. [Comparison](#comparison) 5. [Comparison](#comparison)
- [Speed](#speed) - [Speed](#speed)
- [Privacy](#privacy) - [Privacy](#privacy)
- [Reddit](#reddit) - [Reddit](#reddit)
- [Redlib](#redlib-1) - [Redlib](#redlib-1)
- [Server](#server) - [Server](#server)
5. [Deployment](#deployment) 6. [Deployment](#deployment)
- [Docker](#docker) - [Docker](#docker)
- [Docker Compose](#docker-compose) - [Docker Compose](#docker-compose)
- [Docker CLI](#docker-cli) - [Docker CLI](#docker-cli)
- [Binary](#binary) - [Binary](#binary)
- [Running as a systemd service](#running-as-a-systemd-service) - [Running as a systemd service](#running-as-a-systemd-service)
- [Building from source](#building-from-source) - [Building from source](#building-from-source)
6. [Configuration](#configuration) 7. [Configuration](#configuration)
- [Instance settings](#instance-settings) - [Instance settings](#instance-settings)
- [Default user settings](#default-user-settings) - [Default user settings](#default-user-settings)
@ -328,6 +329,7 @@ Assign a default value for each user-modifiable setting by passing environment v
| `SHOW_NSFW` | `["on", "off"]` | `off` | | `SHOW_NSFW` | `["on", "off"]` | `off` |
| `BLUR_NSFW` | `["on", "off"]` | `off` | | `BLUR_NSFW` | `["on", "off"]` | `off` |
| `USE_HLS` | `["on", "off"]` | `off` | | `USE_HLS` | `["on", "off"]` | `off` |
| `FFMPEG_VIDEO_DOWNLOADS` | `["on", "off"]` | `off` |
| `HIDE_HLS_NOTIFICATION` | `["on", "off"]` | `off` | | `HIDE_HLS_NOTIFICATION` | `["on", "off"]` | `off` |
| `AUTOPLAY_VIDEOS` | `["on", "off"]` | `off` | | `AUTOPLAY_VIDEOS` | `["on", "off"]` | `off` |
| `SUBSCRIPTIONS` | `+`-delimited list of subreddits (`sub1+sub2+sub3+...`) | _(none)_ | | `SUBSCRIPTIONS` | `+`-delimited list of subreddits (`sub1+sub2+sub3+...`) | _(none)_ |