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

56 lines
2.3 KiB
Markdown
Raw Normal View History

2022-03-22 11:30:59 +01:00
<!--
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.
-->
2022-03-22 11:31:08 +01:00
# Libreddit for YunoHost
2022-03-22 11:30:59 +01:00
2022-05-29 07:51:50 +02:00
[![Integration level](https://dash.yunohost.org/integration/libreddit.svg)](https://dash.yunohost.org/appci/app/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)
2022-03-22 11:31:08 +01:00
[![Install Libreddit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libreddit)
2022-03-22 11:30:59 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2022-03-22 11:31:08 +01:00
> *This package allows you to install Libreddit quickly and simply on a YunoHost server.
2022-03-22 11:30:59 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-03-22 11:31:08 +01:00
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.
2022-03-22 11:30:59 +01:00
2022-03-22 11:31:08 +01:00
### Features
2022-03-22 11:30:59 +01:00
2022-03-22 11:31:08 +01:00
🚀 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 prevents browser requests to Reddit
2022-03-22 11:30:59 +01:00
2022-05-29 07:53:41 +02:00
**Shipped version:** 0.22.9~ynh1
2022-03-22 11:30:59 +01:00
2022-03-22 11:31:08 +01:00
**Demo:** https://libreddit.spike.codes/
2022-03-22 11:30:59 +01:00
2022-03-22 11:31:08 +01:00
## Screenshots
2022-03-22 11:30:59 +01:00
2022-05-29 07:51:50 +02:00
![Screenshot of Libreddit](./doc/screenshots/screenshot.png)
2022-03-22 11:30:59 +01:00
## Documentation and resources
2022-05-29 07:51:50 +02:00
* Official app website: <https://libreddit.spike.codes/>
* Upstream app code repository: <https://github.com/spikecodes/libreddit>
* YunoHost documentation for this app: <https://yunohost.org/app_libreddit>
* Report a bug: <https://github.com/YunoHost-Apps/libreddit_ynh/issues>
2022-03-22 11:30:59 +01:00
## Developer info
2022-03-22 11:31:08 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing).
2022-03-22 11:30:59 +01:00
To try the testing branch, please proceed like that.
2022-05-29 07:51:50 +02:00
``` bash
2022-03-22 11:31:08 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing --debug
2022-03-22 11:30:59 +01:00
or
2022-03-22 11:31:08 +01:00
sudo yunohost app upgrade libreddit -u https://github.com/YunoHost-Apps/libreddit_ynh/tree/testing --debug
2022-03-22 11:30:59 +01:00
```
2022-05-29 07:51:50 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>