From 23d1b6ab908aa77ad10cf0ed222e4099dd566a5a Mon Sep 17 00:00:00 2001
From: yunohost-bot <yunohost@yunohost.org>
Date: Sun, 19 Jun 2022 11:45:17 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 15 +++++++++++++++
 README_fr.md | 15 +++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/README.md b/README.md
index da132bc..4f53250 100644
--- a/README.md
+++ b/README.md
@@ -30,8 +30,23 @@ Inspired by the Invidious project.
 
 
 **Shipped version:** 2022.02.11~ynh1
+
+**Demo:** https://nitter.net/
+
+## Screenshots
+
+![Screenshot of Nitter](./doc/screenshots/screenshot.png)
+
+## Disclaimers / important information
+
+### Configuration
+
+Nitter config file is stored in `/opt/yunohost/nitter/nitter.conf` (for the first instance, subsequent installs will go in `nitter__2`, `nitter__3`, etc). Users can override the defaults and set custom settings at `https://instance-domain.tld/settings`.
 ## Documentation and resources
 
+* Official app website: <https://nitter.net/>
+* Official admin documentation: <https://github.com/zedeus/nitter/wiki>
+* Upstream app code repository: <https://github.com/zedeus/nitter>
 * YunoHost documentation for this app: <https://yunohost.org/app_nitter>
 * Report a bug: <https://github.com/YunoHost-Apps/nitter_ynh/issues>
 
diff --git a/README_fr.md b/README_fr.md
index d5749be..f486711 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -30,8 +30,23 @@ Inspired by the Invidious project.
 
 
 **Version incluse :** 2022.02.11~ynh1
+
+**Démo :** https://nitter.net/
+
+## Captures d'écran
+
+![Capture d'écran de Nitter](./doc/screenshots/screenshot.png)
+
+## Avertissements / informations importantes
+
+### Configuration
+
+Nitter config file is stored in `/opt/yunohost/nitter/nitter.conf` (for the first instance, subsequent installs will go in `nitter__2`, `nitter__3`, etc). Users can override the defaults and set custom settings at `https://instance-domain.tld/settings`.
 ## Documentations et ressources
 
+* Site officiel de l'app : <https://nitter.net/>
+* Documentation officielle de l'admin : <https://github.com/zedeus/nitter/wiki>
+* Dépôt de code officiel de l'app : <https://github.com/zedeus/nitter>
 * Documentation YunoHost pour cette app : <https://yunohost.org/app_nitter>
 * Signaler un bug : <https://github.com/YunoHost-Apps/nitter_ynh/issues>