aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoreric_G <46165813+ericgaspar@users.noreply.github.com>2025-09-01 11:40:59 +0200
committereric_G <46165813+ericgaspar@users.noreply.github.com>2025-09-01 11:40:59 +0200
commitf153dc5aa68f66d3fabe39baa54f7fcdad8e3ebf (patch)
tree3ec47391ead537455cb4c613fc22654258a1d07c /README.md
parent8d27dd88c49efc56bf983df313dc42af26c63a77 (diff)
parentedbf9871a19fd30634d86e7ff41d4f33b92521d4 (diff)
downloadmastodon_ynh-f153dc5aa68f66d3fabe39baa54f7fcdad8e3ebf.tar.gz
mastodon_ynh-f153dc5aa68f66d3fabe39baa54f7fcdad8e3ebf.tar.bz2
mastodon_ynh-f153dc5aa68f66d3fabe39baa54f7fcdad8e3ebf.zip
Merge branch 'testing' into pr/466
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 26 insertions, 32 deletions
diff --git a/README.md b/README.md
index c676435..e285399 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,45 @@
<!--
-N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
+N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
It shall NOT be edited by hand.
-->
-# Mastodon for YunoHost
+<h1>
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/mastodon.png" width="32px" alt="Logo of Mastodon">
+ Mastodon, packaged for YunoHost
+</h1>
-[![Integration level](https://dash.yunohost.org/integration/mastodon.svg)](https://ci-apps.yunohost.org/ci/apps/mastodon/) ![Working status](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mastodon.maintain.svg)
+Libre and federated social network
-[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)
+[![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://joinmastodon.org/)
+[![App Demo](https://img.shields.io/badge/App_Demo-blue?style=for-the-badge)](https://joinmastodon.org/)
+[![Version: 4.4.3~ynh1](https://img.shields.io/badge/Version-4.4.3~ynh1-rgb(18,138,11)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/mastodon/)
-*[Read this README in other languages.](./ALL_README.md)*
+<div align="center">
+<a href="https://apps.yunohost.org/app/mastodon"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
+<a href="https://github.com/YunoHost-Apps/mastodon_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
+</div>
-> *This package allows you to install Mastodon 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
-
-Mastodon is a free, open-source microblogging social network.
-It is a decentralized alternative to commercial platforms like Twitter and avoids the risks of a single company monopolizing your communication for commercial purposes.
-
-
-**Shipped version:** 4.2.12~ynh1
-
-**Demo:** <https://joinmastodon.org/>
## Screenshots
-
![Screenshot of Mastodon](./doc/screenshots/mastodon.png)
-## Documentation and resources
+## 📦 Developer info
-- Official app website: <https://joinmastodon.org/>
-- Official admin documentation: <https://docs.joinmastodon.org/>
-- Upstream app code repository: <https://github.com/mastodon/mastodon>
-- YunoHost Store: <https://apps.yunohost.org/app/mastodon>
-- Report a bug: <https://github.com/YunoHost-Apps/mastodon_ynh/issues>
+[![Automatic tests level](https://apps.yunohost.org/badge/cilevel/mastodon)](https://ci-apps.yunohost.org/ci/apps/mastodon/)
-## Developer info
+🛠️ Upstream Mastodon repository: <https://github.com/mastodon/mastodon>
-Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).
-To try the `testing` branch, please proceed like that:
+The `testing` branch can be tested using:
+```
+# fresh install:
+sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing
-```bash
-sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
-or
-sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
+# upgrade an existing install:
+sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing
```
-**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
+### 📚 App packaging documentation
+
+Please see <https://doc.yunohost.org/packaging_apps> for more information. \ No newline at end of file