From 832db52b0beac77f9a1ed510d2dd5dd10b926a88 Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Wed, 7 Jul 2021 09:59:58 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 19 +++++++++++++++++++
 README_fr.md | 18 ++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/README.md b/README.md
index 252a8f6..29af152 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,29 @@ Digital books streamer, providing web-based access to your e-book collection.
 
 **Shipped version:** 1.5.3~ynh1
 
+**Demo:** https://demo.example.com
 
+## Screenshots
+
+![](./doc/screenshots/bbs-121-recent.png)
+
+## Disclaimers / important information
+
+BicBucStriim is a simple PHP application that runs in the Apache/PHP environment provided by the NAS (or any other server). It assumes that you manage your e-book collection with Calibre. The application reads the [https://calibre-ebook.com/](Calibre) data and publishes it in HTML form. To access the e-book catalog you simply point your ebook reader to your NAS, select one of your e-books and download it.
+
+## Configuration
+
+A freshly installed BicBucStriim installation will show the login page. The initial login information for the administrator is
+
+    user name: admin
+    password : admin
 
 ## Documentation and resources
 
+* Official app website: http://projekte.textmulch.de/bicbucstriim/
+* Official user documentation: https://yunohost.org/apps
+* Official admin documentation: https://yunohost.org/packaging_apps
+* Upstream app code repository: https://github.com/rvolz/BicBucStriim
 * YunoHost documentation for this app: https://yunohost.org/app_bicbucstriim
 * Report a bug: https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues
 
diff --git a/README_fr.md b/README_fr.md
index 244d252..fbac65d 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -15,10 +15,28 @@ Interface web pour accéder à votre collection d'e-book.
 
 **Version incluse :** 1.5.3~ynh1
 
+**Démo :** https://demo.example.com
 
+## Captures d'écran
 
+![](./doc/screenshots/bbs-121-recent.png)
+
+## Avertissements / informations importantes
+
+BicBucStriim est une application PHP simple qui s'exécute dans l'environnement Apache/PHP fourni par le NAS (ou tout autre serveur). Cela suppose que vous gérez votre collection de livres électroniques avec Calibre. L'application lit les données [https://calibre-ebook.com/](Calibre) et les publie sous forme HTML. Pour accéder au catalogue de livres électroniques, il vous suffit de pointer votre lecteur de livres électroniques sur votre NAS, de sélectionner l'un de vos livres électroniques et de le télécharger.
+
+## Configuration
+
+Une installation de BicBucStriim fraîchement installée affichera la page de connexion. Les informations de connexion initiales de l'administrateur sont
+
+     nom d'utilisateur : admin
+     mot de passe : admin
 ## Documentations et ressources
 
+* Site officiel de l'app : http://projekte.textmulch.de/bicbucstriim/
+* 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://github.com/rvolz/BicBucStriim
 * Documentation YunoHost pour cette app : https://yunohost.org/app_bicbucstriim
 * Signaler un bug : https://github.com/YunoHost-Apps/bicbucstriim_ynh/issues