1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/libreddit_ynh.git synced 2024-09-03 19:36:05 +02:00
libreddit_ynh/README.md
2024-08-30 11:58:50 +00:00

56 lines
2.2 KiB
Markdown

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->
# Libreddit for YunoHost
[![Integration level](https://dash.yunohost.org/integration/libreddit.svg)](https://ci-apps.yunohost.org/ci/apps/libreddit/) ![Working status](https://ci-apps.yunohost.org/ci/badges/libreddit.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/libreddit.maintain.svg)
[![Install Libreddit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreddit)
*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install Libreddit quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
Libreddit is a portmanteau of "libre" (meaning freedom) and "Reddit". It is a private front-end like Invidious but for Reddit. Browse the coldest takes of r/unpopularopinion without being tracked.
### Features
- Written in Rust for blazing fast speeds and memory safety
- No JavaScript, no ads, no tracking, no bloat
- All requests are proxied through the server, including media
- Strong Content Security Policy prevents browser requests to Reddit
**Shipped version:** 3.0.0~ynh1
**Demo:** <https://libreddit.spike.codes/>
## Screenshots
![Screenshot of Libreddit](./doc/screenshots/screenshot.png)
## Documentation and resources
- Official app website: <https://libreddit.spike.codes/>
- Upstream app code repository: <https://github.com/spikecodes/libreddit>
- YunoHost Store: <https://apps.yunohost.org/app/libreddit>
- Report a bug: <https://github.com/YunoHost-Apps/libreddit_ynh/issues>
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing --debug
or
sudo yunohost app upgrade libreddit -u https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>