Auto-update README

README.md

@@ -1,67 +1,50 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Nitter for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![Working status](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg)  
 [![Install Nitter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install Nitter quickly and simply on a YunoHost server.  
+> *This package allows you to install Nitter 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
-Nitter is an alternative front-end for Twitter that is faster than the official website, respects your privacy, and does not require login. It uses responsive design (works well on all screen sizes). Nitter also offers to generate RSS feeds from Twitter user timeleines.
 
-This app requires a dedicated root domain. **ARM installations are NOT SUPPORTED.**
+A free and open source alternative Twitter front-end focused on privacy and performance.
+Inspired by the Invidious project.
 
-**Shipped version:** 2022-02-11
+### Features
+- No JavaScript or ads
+- All requests go through the backend, client never talks to Twitter
+- Prevents Twitter from tracking your IP or JavaScript fingerprint
+- Uses Twitter's unofficial API (no rate limits or developer account required)
+- Lightweight (for @nim_lang, 60KB vs 784KB from twitter.com)
+- RSS feeds
+- Themes
+- Mobile support (responsive design)
 
-## Screenshots
 
-![](https://raw.githubusercontent.com/zedeus/nitter/master/screenshot.png)
+**Shipped version:** 2022.02.11~ynh1
+## Documentation and resources
 
-## Demo
+* YunoHost documentation for this app: <https://yunohost.org/app_nitter>
-
+* Report a bug: <https://github.com/YunoHost-Apps/nitter_ynh/issues>
-* [Official demo](https://nitter.net)
-
-## Configuration
-
-The app's 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
-
- * Official documentation: https://github.com/zedeus/nitter/wiki
-
-#### Multi-user support
-
- * Are LDAP and HTTP auth supported? **No**
- * Can the app be used by multiple users? **Yes**
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/nitter%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/nitter/)
-* ARMv8-A - **NOT SUPPORTED**
-
-## Limitations
-
-* ARM installations are not supported and will not work
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/nitter_ynh/issues
- * App website: https://github.com/zedeus/nitter
- * Upstream app repository: https://github.com/zedeus/nitter
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nitter_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade nitter -u https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

README_fr.md

@@ -1,66 +1,50 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Nitter pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg)  
 [![Installer Nitter avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter)
 
-*[Read this readme in english.](./README.md)* 
+*[Read this readme in english.](./README.md)*
 
-> *Ce package vous permet d'installer Nitter rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer Nitter rapidement et simplement sur un serveur YunoHost.
-Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
-Nitter est une interface alternative pour Twitter qui est plus rapide que le site officiel, respecte votre vie privée, est ne nécessite pas de s'enregistrer. Son nterface s'adapte aux écrans de toutes tailles. Nitter offre aussi de générer des flux RSS à partir des timelines des utilisateurs Twitter.
 
-Cette application nécéssite un domaine dedié. **L'installation sur ARM n'est PAS PRISE EN CHARGE.**
+A free and open source alternative Twitter front-end focused on privacy and performance.
+Inspired by the Invidious project.
 
-**Version incluse :** 2022-02-11
+### Features
+- No JavaScript or ads
+- All requests go through the backend, client never talks to Twitter
+- Prevents Twitter from tracking your IP or JavaScript fingerprint
+- Uses Twitter's unofficial API (no rate limits or developer account required)
+- Lightweight (for @nim_lang, 60KB vs 784KB from twitter.com)
+- RSS feeds
+- Themes
+- Mobile support (responsive design)
 
-## Captures d'écran
 
-![](https://raw.githubusercontent.com/zedeus/nitter/master/screenshot.png)
+**Version incluse :** 2022.02.11~ynh1
+## Documentations et ressources
 
-## Démo
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_nitter>
-
+* Signaler un bug : <https://github.com/YunoHost-Apps/nitter_ynh/issues>
-* [Démo officielle](htts://nitter.net)
-
-## Configuration
-
-Le ficher de configuration de l'appli se trouve à `/opt/yunohost/nitter/nitter.conf` (pour la première installation, les prochaines installations iront dans `nitter__2`, `nitter__3`, etc). 
-Les utilisateurs peuvent modifier les paramétres par défaut en visitant`https://instance-domain.tld/settings`.
-
-## Documentation
-
- * Documentation officielle : https://github.com/zedeus/nitter/wiki
-
-#### Support multi-utilisateur
-
-* L'authentification LDAP et HTTP est-elle prise en charge ? **Non**
-* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
-
-#### Architectures supportées
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/nitter%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/nitter/)
-* ARMv8-A - **PAS PRIS EN CHARGE**
-## Limitations
-
-* Les installations sur ARM ne sont pas prises en charge et ne marcheront pas.
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/nitter_ynh/issues
- * Site de l'application : https://github.com/zedeus/nitter
- * Dépôt de l'application principale : https://github.com/zedeus/nitter
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/nitter_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade nitter -u https://github.com/YunoHost-Apps/nitter_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>