From f6f9d41d358971e4848f38eadf4158623683ddcd Mon Sep 17 00:00:00 2001 From: rungeard Date: Wed, 12 May 2021 19:40:07 +0200 Subject: [PATCH] edit readme --- README.md | 15 ++++----------- README_fr.md | 15 ++++----------- doc/DISCLAIMER.md | 11 ++--------- 3 files changed, 10 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 35cd36b..bdae11a 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. +Very lightweight Speedtest. -**Shipped version:** 1.0~ynh1 +**Shipped version:** 5.2.4~ynh1 **Demo:** https://librespeed.org/ @@ -37,17 +37,10 @@ This is a very lightweight Speedtest implemented in Javascript, using XMLHttpReq ## Disclaimers / important information * Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... + * Please visit [Troubleshooting, common problems, known limitations](https://github.com/librespeed/speedtest/wiki/Troubleshooting,-common-problems,-known-limitations) for more informations. * Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? + * A basic front-end for visualizing and searching tests by ID is available in `domain.tld/results/stats.php`. A password is asked to you during installation steps to access this page. diff --git a/README_fr.md b/README_fr.md index 36426e4..1e9bd99 100644 --- a/README_fr.md +++ b/README_fr.md @@ -11,9 +11,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Vue d'ensemble -Test de vitesse de connexion très léger implémenté en Javascript, utilisant XMLHttpRequest et Web Workers. +Test de vitesse de connexion très léger. -**Version incluse:** 1.0~ynh1 +**Version incluse:** 5.2.4~ynh1 **Démo:** https://librespeed.org/ @@ -29,17 +29,10 @@ Test de vitesse de connexion très léger implémenté en Javascript, utilisant ## Avertissements / informations importantes * Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... + * Please visit [Troubleshooting, common problems, known limitations](https://github.com/librespeed/speedtest/wiki/Troubleshooting,-common-problems,-known-limitations) for more informations. * Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? + * A basic front-end for visualizing and searching tests by ID is available in `domain.tld/results/stats.php`. A password is asked to you during installation steps to access this page. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index aded581..391c1d1 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,12 +1,5 @@ * Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... + * Please visit [Troubleshooting, common problems, known limitations](https://github.com/librespeed/speedtest/wiki/Troubleshooting,-common-problems,-known-limitations) for more informations. * Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? + * A basic front-end for visualizing and searching tests by ID is available in `domain.tld/results/stats.php`. A password is asked to you during installation steps to access this page.