1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/librarian_ynh.git synced 2024-09-03 19:36:01 +02:00
librarian_ynh/README.md

58 lines
2.1 KiB
Markdown
Raw Normal View History

2022-05-28 11:54:59 +02: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-05-28 11:55:04 +02:00
# Librarian for YunoHost
2022-05-28 11:54:59 +02:00
2022-05-28 11:55:04 +02:00
[![Integration level](https://dash.yunohost.org/integration/librarian.svg)](https://dash.yunohost.org/appci/app/librarian) ![Working status](https://ci-apps.yunohost.org/ci/badges/librarian.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/librarian.maintain.svg)
[![Install Librarian with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librarian)
2022-05-28 11:54:59 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-05-28 11:55:04 +02:00
> *This package allows you to install Librarian quickly and simply on a YunoHost server.
2022-05-28 11:54:59 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-05-28 11:55:04 +02:00
An alternative frontend for LBRY/Odysee. Inspired by Invidious and Libreddit.
2022-05-28 11:54:59 +02:00
2022-05-28 11:55:04 +02:00
### Features
2022-05-28 11:54:59 +02:00
2022-05-28 11:55:04 +02:00
- Lightweight
- JavaScript not required*
- No ads
- No tracking
- No crypto garbage
2022-05-28 11:54:59 +02:00
2022-05-28 13:38:52 +02:00
**Shipped version:** 2022.05.14~ynh1
2022-05-28 11:54:59 +02:00
2022-05-28 11:55:04 +02:00
**Demo:** https://lbry.bcow.xyz/@RetroMusic:d/1987-Rick-Astley-Never-Gonna-Give-You-Up-1920x1080:f
2022-05-28 11:54:59 +02:00
2022-05-28 11:55:04 +02:00
## Screenshots
2022-05-28 11:54:59 +02:00
2022-05-28 12:14:51 +02:00
![Screenshot of Librarian](./doc/screenshots/screeshot.png)
2022-05-28 11:54:59 +02:00
## Documentation and resources
2022-05-28 12:53:14 +02:00
* Official app website: <https://lbry.bcow.xyz/>
2022-05-28 12:55:53 +02:00
* Official admin documentation: <https://codeberg.org/librarian/librarian/wiki>
2022-05-28 11:55:04 +02:00
* Upstream app code repository: <https://codeberg.org/librarian/librarian>
* YunoHost documentation for this app: <https://yunohost.org/app_librarian>
* Report a bug: <https://github.com/YunoHost-Apps/librarian_ynh/issues>
2022-05-28 11:54:59 +02:00
## Developer info
2022-05-28 11:55:04 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/librarian_ynh/tree/testing).
2022-05-28 11:54:59 +02:00
To try the testing branch, please proceed like that.
2022-05-28 11:55:04 +02:00
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/librarian_ynh/tree/testing --debug
2022-05-28 11:54:59 +02:00
or
2022-05-28 11:55:04 +02:00
sudo yunohost app upgrade librarian -u https://github.com/YunoHost-Apps/librarian_ynh/tree/testing --debug
2022-05-28 11:54:59 +02:00
```
2022-05-28 11:55:04 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>