From 42e2cf47516ad9a703986e11a3d284e8b20ec391 Mon Sep 17 00:00:00 2001
From: yunohost-bot <yunohost@yunohost.org>
Date: Tue, 20 Feb 2024 14:01:28 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 README_fr.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+)
 create mode 100644 README.md
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..771e9bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+<!--
+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.
+-->
+
+# Iceshrimp for YunoHost
+
+[![Integration level](https://dash.yunohost.org/integration/iceshrimp.svg)](https://dash.yunohost.org/appci/app/iceshrimp) ![Working status](https://ci-apps.yunohost.org/ci/badges/iceshrimp.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/iceshrimp.maintain.svg)
+
+[![Install Iceshrimp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=iceshrimp)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Iceshrimp 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
+
+Iceshrimp is a decentralized and federated social networking service, implementing the ActivityPub standard.
+
+It was forked from Calckey Firefish (itself a fork of Misskey) in mid-2023, to focus on stability, performance and usability instead of new features.
+
+**Shipped version:** 2023.12.5~ynh1
+
+## Screenshots
+
+![Screenshot of Iceshrimp](./doc/screenshots/example.jpg)
+
+## Documentation and resources
+
+* Official app website: <https://iceshrimp.dev>
+* Upstream app code repository: <https://iceshrimp.dev/iceshrimp/iceshrimp>
+* YunoHost Store: <https://apps.yunohost.org/app/iceshrimp>
+* Report a bug: <https://github.com/YunoHost-Apps/iceshrimp_ynh/issues>
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade iceshrimp -u https://github.com/YunoHost-Apps/iceshrimp_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
new file mode 100644
index 0000000..181433d
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,48 @@
+<!--
+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.
+-->
+
+# Iceshrimp pour YunoHost
+
+[![Niveau d’intégration](https://dash.yunohost.org/integration/iceshrimp.svg)](https://dash.yunohost.org/appci/app/iceshrimp) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/iceshrimp.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/iceshrimp.maintain.svg)
+
+[![Installer Iceshrimp avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=iceshrimp)
+
+*[Read this readme in english.](./README.md)*
+
+> *Ce package vous permet d’installer Iceshrimp rapidement et simplement sur un serveur YunoHost.
+Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
+
+## Vue d’ensemble
+
+Iceshrimp est un service de réseau social décentralisé et fédéré, implémentant le standard ActivityPub.
+
+Il a été forké de Calckey et Firefish (lui-même forké de Misskey) à la mi-2023, afin de se concentrer sur la stabilité, les performances et la facilité d'utilisation plutôt que sur de nouvelles fonctionnalités.
+
+**Version incluse :** 2023.12.5~ynh1
+
+## Captures d’écran
+
+![Capture d’écran de Iceshrimp](./doc/screenshots/example.jpg)
+
+## Documentations et ressources
+
+* Site officiel de l’app : <https://iceshrimp.dev>
+* Dépôt de code officiel de l’app : <https://iceshrimp.dev/iceshrimp/iceshrimp>
+* YunoHost Store: <https://apps.yunohost.org/app/iceshrimp>
+* Signaler un bug : <https://github.com/YunoHost-Apps/iceshrimp_ynh/issues>
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade iceshrimp -u https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
+```
+
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
\ No newline at end of file