diff --git a/README.md b/README.md index 4a124be..e9b3098 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Haste for YunoHost [![Integration level](https://dash.yunohost.org/integration/haste.svg)](https://dash.yunohost.org/appci/app/haste) ![](https://ci-apps.yunohost.org/ci/badges/haste.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/haste.maintain.svg) @@ -5,49 +10,29 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Haste quickly and simply on a YunoHost server. +> *This package allows you to install Haste 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 + Haste is an open-source pastebin software written in node.js, which is easily installable in any network. YunoHost Project uses Haste as pastebin for log sharing: [paste.yunohost.org](https://paste.yunohost.org/) -**Shipped version:** 0.1.0 (7.10.2020) + +**Shipped version:** 0.1.0~ynh8 + +**Demo:** http://hastebin.com/ ## Screenshots -![](sources/screenshot.png) +![](./doc/screenshots/screenshot.png) -## Demo - -* [Official demo](http://hastebin.com/) - -## Configuration - - * How to configure this app: a plain file with SSH. - -## Documentation - - * Official documentation: https://hastebin.com/about.md - * YunoHost documentation: https://yunohost.org/en/app_haste - -## YunoHost specific features +## Disclaimers / important information #### Multi-user support * Are LDAP and HTTP auth supported? **No** * Can the app be used by multiple users? **Yes** -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/haste.svg)](https://ci-apps.yunohost.org/ci/apps/haste/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/haste.svg)](https://ci-apps-arm.yunohost.org/ci/apps/haste/) - -## Limitations - -* Any known limitations. - -## Additional information - ## `haste` command This Haste package for Yunohost includes the [`haste` command](https://github.com/diethnis/standalones/blob/master/hastebin.sh), allowing you to share content from terminal: @@ -58,13 +43,13 @@ https://haste.example.com/zuyejeduzu ``` The [Haste-client](https://github.com/seejohnrun/haste-client) is a simple client for uploading data to you Haste server. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/haste_ynh/issues - * Upstream app repository: https://github.com/seejohnrun/haste-server - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://example.com +* Official user documentation: https://hastebin.com/about.md +* Upstream app code repository: https://github.com/seejohnrun/haste-server +* YunoHost documentation for this app: https://yunohost.org/app_haste +* Report a bug: https://github.com/YunoHost-Apps/haste_ynh/issues ## Developer info @@ -76,3 +61,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/haste_ynh/tree/testin or sudo yunohost app upgrade haste -u https://github.com/YunoHost-Apps/haste_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 index d7ad440..6a33daf 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,51 +3,32 @@ [![Niveau d'intégration](https://dash.yunohost.org/integration/haste.svg)](https://dash.yunohost.org/appci/app/haste) ![](https://ci-apps.yunohost.org/ci/badges/haste.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/haste.maintain.svg) [![Installer Haste avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=haste) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Haste rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Haste 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 + Haste est un logiciel pastebin open-source écrit en node.js, facilement installable sur n'importe quel réseau. Le projet YunoHost utilise Haste comme pastebin pour le partage de log : [paste.yunohost.org](https://paste.yunohost.org/) -**Version incluse :** 0.1.0 (7.10.2020) + +**Version incluse :** 0.1.0~ynh8 + +**Démo :** http://hastebin.com/ ## Captures d'écran -![](sources/screenshot.png) +![](./doc/screenshots/screenshot.png) -## Démo +## Avertissements / informations importantes -* [Démo officielle](http://hastebin.com/) - -## Configuration - - * Comment configurer cette application: un fichier brut en SSH. - -## Documentation - - * Documentation officielle: https://hastebin.com/about.md - * Documentation YunoHost: https://yunohost.org/fr/app_haste - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur +### Support multi-utilisateur * L'authentification LDAP et HTTP est-elle prise en charge ? **Non** * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/haste.svg)](https://ci-apps.yunohost.org/ci/apps/haste/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/haste.svg)](https://ci-apps-arm.yunohost.org/ci/apps/haste/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - ## `haste` command Ce paquet de Haste pour YunoHost comprend une commande [`haste`](https://github.com/diethnis/standalones/blob/master/hastebin.sh), vous permettant de partager du contenu avec le terminal : @@ -59,13 +40,13 @@ https://haste.example.com/zuyejeduzu Le [client Haste](https://github.com/seejohnrun/haste-client) est un client simple pour télécharger des données sur votre serveur Haste. -## Liens +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/haste_ynh/issues - * Dépôt de l'application principale : https://github.com/seejohnrun/haste-server - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://example.com +* Documentation officielle utilisateur : https://hastebin.com/about.md +* Dépôt de code officiel de l'app : https://github.com/seejohnrun/haste-server +* Documentation YunoHost pour cette app : https://yunohost.org/app_haste +* Signaler un bug : https://github.com/YunoHost-Apps/haste_ynh/issues ## Informations pour les développeurs @@ -77,3 +58,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/haste_ynh/tree/testin ou sudo yunohost app upgrade haste -u https://github.com/YunoHost-Apps/haste_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file