diff --git a/README.md b/README.md index be43b34..01becc5 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,45 @@ + + # BoZoN for YunoHost -[![Integration level](https://dash.yunohost.org/integration/bozon.svg)](https://dash.yunohost.org/appci/app/bozon) ![](https://ci-apps.yunohost.org/ci/badges/bozon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/bozon.maintain.svg) -[![Install BoZoN with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=bozon) +[![Integration level](https://dash.yunohost.org/integration/bozon.svg)](https://dash.yunohost.org/appci/app/bozon) ![Working status](https://ci-apps.yunohost.org/ci/badges/bozon.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bozon.maintain.svg) +[![Install BoZoN with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bozon) -> *This package allows you to install BoZoN quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install BoZoN 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 + BoZoN is a minimalist Drag & drop file sharing app. -**Shipped version:** 2.4.18 + +**Shipped version:** 2.4.18~ynh1 ## Screenshots -![](sources/bozon_screenshot.png) +![Screenshot of BoZoN](./doc/screenshots/bozon_screenshot.png) -## Configuration +## Documentation and resources -How to configure this app: From an admin panel, a plain file with SSH, or any other way. - -## Documentation - - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - -* Are LDAP and HTTP auth supported? -* Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/bozon%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/bozon/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/bozon%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/bozon/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/bozon_ynh/issues - * Upstream app repository: https://github.com/broncowdd/BoZoN - * YunoHost website: https://yunohost.org/ - ---- +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bozon_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug or sudo yunohost app upgrade bozon -u https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..8889bd2 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,45 @@ + + +# BoZoN pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/bozon.svg)](https://dash.yunohost.org/appci/app/bozon) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/bozon.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/bozon.maintain.svg) +[![Installer BoZoN avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bozon) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer BoZoN 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 + +BoZoN is a minimalist Drag & drop file sharing app. + + +**Version incluse :** 2.4.18~ynh1 + +## Captures d'écran + +![Capture d'écran de BoZoN](./doc/screenshots/bozon_screenshot.png) + +## Documentations et ressources + +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/bozon_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug +ou +sudo yunohost app upgrade bozon -u https://github.com/YunoHost-Apps/bozon_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :**