diff --git a/README.md b/README.md index d58287b..35cd36b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,4 @@ -# Packaging your an app, starting from this example - -- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. - - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `doc/DISCLAIMER*.md` -- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator - --- @@ -17,29 +7,29 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app It shall NOT be edited by hand. --> -# Example app for YunoHost +# LibreSpeed for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Integration level](https://dash.yunohost.org/integration/librespeed.svg)](https://dash.yunohost.org/appci/app/librespeed) ![](https://ci-apps.yunohost.org/ci/badges/librespeed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/librespeed.maintain.svg) +[![Install librespeed with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librespeed) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install librespeed 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 -Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) +This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. **Shipped version:** 1.0~ynh1 -**Demo:** https://demo.example.com +**Demo:** https://librespeed.org/ ## Screenshots - ![](./doc/screenshots/example.jpg) + ![](./doc/screenshots/librespeed_screenshot.gif) @@ -63,22 +53,22 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does ## Documentation and resources -* Official app website: https://example.com +* Official app website: https://librespeed.org/ * Official user documentation: https://yunohost.org/apps * Official admin documentation: https://yunohost.org/packaging_apps -* Upstream app code repository: https://some.forge.com/example/example -* YunoHost documentation for this app: https://yunohost.org/app_example -* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Upstream app code repository: https://github.com/librespeed/speedtest +* YunoHost documentation for this app: https://yunohost.org/app_librespeed +* Report a bug: https://github.com/YunoHost-Apps/librespeed_ynh/issues ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade librespeed -u https://github.com/YunoHost-Apps/librespeed_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 d856bf9..36426e4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,27 +1,27 @@ -# Example app pour YunoHost +# LibreSpeed pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](https://dash.yunohost.org/integration/librespeed.svg)](https://dash.yunohost.org/appci/app/librespeed) ![](https://ci-apps.yunohost.org/ci/badges/librespeed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/librespeed.maintain.svg) +[![Installer librespeed avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librespeed) *[Read this readme in english.](./README.md)* *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install librespeed 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.* ## Vue d'ensemble -Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) +Test de vitesse de connexion très léger implémenté en Javascript, utilisant XMLHttpRequest et Web Workers. **Version incluse:** 1.0~ynh1 -**Démo:** https://demo.example.com +**Démo:** https://librespeed.org/ ## Captures d'écran - ![](./doc/screenshots/example.jpg) + ![](./doc/screenshots/librespeed_screenshot.gif) @@ -45,22 +45,22 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o ## Documentations et ressources -* Site official de l'app : https://example.com +* Site official de l'app : https://librespeed.org/ * Documentation officielle utilisateur: https://yunohost.org/apps * Documentation officielle de l'admin: https://yunohost.org/packaging_apps -* Dépôt de code officiel de l'app: https://some.forge.com/example/example -* Documentation YunoHost pour cette app: https://yunohost.org/app_example -* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Dépôt de code officiel de l'app: https://github.com/librespeed/speedtest +* Documentation YunoHost pour cette app: https://yunohost.org/app_librespeed +* Signaler un bug: https://github.com/YunoHost-Apps/librespeed_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade librespeed -u https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing --debug ``` **Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file