diff --git a/README.md b/README.md index 98fdb9e..59f9430 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,43 @@ -## headphones_ynh + -[![Latest Version](https://img.shields.io/badge/version-_--_-green.svg?style=flat)](https://github.com/Snipees/headphones_ynh/releases) -[![Status](https://img.shields.io/badge/status-in_progress-yellow.svg?style=flat)](https://github.com/Snipees/headphones_ynh/milestones) -[![Dependencies](https://img.shields.io/badge/dependencies-includes-lightgrey.svg?style=flat)](https://github.com/Snipees/headphones_ynh#dependencies) -[![GitHub license](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/Snipees/headphones_ynh/master/LICENSE) -[![Yunohost version](https://img.shields.io/badge/yunohost-2.2.0_tested-orange.svg?style=flat)](https://github.com/YunoHost/yunohost) -[![GitHub issues](https://img.shields.io/github/issues/Snipees/headphones_ynh.svg?style=flat)](https://github.com/Snipees/headphones_ynh/issues) - -[ **Headphones Integration for Yunohost** ] -This install script uses a Git-fork as sources for a local installation. -Otherwise the script sets a reverse-proxy to a remote instance. +# Headphones for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/headphones.svg)](https://dash.yunohost.org/appci/app/headphones) ![](https://ci-apps.yunohost.org/ci/badges/headphones.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/headphones.maintain.svg) +[![Install Headphones with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headphones) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Headphones 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 + +Automated music downloader for NZB and Torrent + +**Shipped version:** 0.6.0~ynh1 -### How to install: -- Use **Install software** option from Yunohost admin panel -- Find textbox tagged as **Install custom App from github** -- Copy and paste: https://github.com/YunoHost-Apps/headphones_ynh -- Choose the method installation: *local* or *remote* (as described above) -- Answer the required questions to the selected method +## Documentation and resources -### More information about: -- Headphones : https://github.com/rembo10/headphones -- Yunohost : https://yunohost.org +* Official app website: https://github.com/rembo10/headphones +* Official user documentation: https://github.com/rembo10/headphones/wiki/Usage-guide +* Upstream app code repository: https://github.com/rembo10/headphones +* YunoHost documentation for this app: https://yunohost.org/app_headphones +* Report a bug: https://github.com/YunoHost-Apps/headphones_ynh/issues +## Developer info -#### Special Thanks to the Yunohost Community: -[anaqreon](https://github.com/anaqreon), -[aymhce](https://github.com/aymhce), -[beudbeud](https://github.com/abeudin), -[Chao-Man](https://github.com/Chao-Man), -[chtixof](https://github.com/chtixof), -[CotzaDev](https://github.com/CotzaDev), -[courgette](https://github.com/courgette), -[Jérôme](https://github.com/jeromelebleu), -[JocelynD](https://github.com/JocelynDelalande), -[Ju](https://github.com/julienmalik), -[Le Kload](https://github.com/Kloadut), -[lunarok](https://github.com/lunarok), -[maniackcrudelis](https://github.com/maniackcrudelis), -[Matlink](https://github.com/matlink), -[Moul](https://github.com/M5oul), -[polytan02](https://github.com/polytan02), -[scith](https://github.com/scith), -[tifred](https://github.com/drfred1981), -... :dizzy: +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/headphones_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/headphones_ynh/tree/testing --debug +or +sudo yunohost app upgrade headphones -u https://github.com/YunoHost-Apps/headphones_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..9d1f70b --- /dev/null +++ b/README_fr.md @@ -0,0 +1,39 @@ +# Headphones pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/headphones.svg)](https://dash.yunohost.org/appci/app/headphones) ![](https://ci-apps.yunohost.org/ci/badges/headphones.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/headphones.maintain.svg) +[![Installer Headphones avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headphones) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Headphones rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Automated music downloader for NZB and Torrent + +**Version incluse :** 0.6.0~ynh1 + + + +## Documentations et ressources + +* Site officiel de l'app : https://github.com/rembo10/headphones +* Documentation officielle utilisateur : https://github.com/rembo10/headphones/wiki/Usage-guide +* Dépôt de code officiel de l'app : https://github.com/rembo10/headphones +* Documentation YunoHost pour cette app : https://yunohost.org/app_headphones +* Signaler un bug : https://github.com/YunoHost-Apps/headphones_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/headphones_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/headphones_ynh/tree/testing --debug +ou +sudo yunohost app upgrade headphones -u https://github.com/YunoHost-Apps/headphones_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file