aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 24 insertions, 22 deletions
diff --git a/README.md b/README.md
index a551c91..8983f7e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
+<!--
+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.
+-->
+
# Mastodon for YunoHost
[![Integration level](https://dash.yunohost.org/integration/mastodon.svg)](https://dash.yunohost.org/appci/app/mastodon) ![](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mastodon.maintain.svg)
@@ -5,13 +10,22 @@
*[Lire ce readme en français.](./README_fr.md)*
-> *This package allows you to install Mastodon quickly and simply on a YunoHost server.
+> *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:** 3.4.1
+**Shipped version:** 3.4.4~ynh1
+
+**Demo:** https://joinmastodon.org/
+
+## Screenshots
+
+![](./doc/screenshots/mastodon.png)
+
+## Disclaimers / important information
## Important points to read before installing
@@ -20,10 +34,6 @@ Mastodon is a free, open-source microblogging social network. It is a decentrali
1. At the end of the installation a mail is sent to the user with the automatically generated password
1. It seems important to close the inscriptions for your Mastodon, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.
-## Screenshots
-
-![](https://framalibre.org/sites/default/files/mastodon.png)
-
## Configuration
### Install
@@ -50,29 +60,19 @@ $ screen -r
`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)`
-## Documentation
-
- * Official documentation: https://docs.joinmastodon.org/
-
## YunoHost specific features
#### Multi-users support
LDAP authentication is activated. All YunoHost users can authenticate.
-#### Supported architectures
+## Documentation and resources
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mastodon.svg)](https://ci-apps.yunohost.org/ci/apps/mastodon/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mastodon.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mastodon/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/mastodon_ynh/issues
- * App website: https://joinmastodon.org/
- * Upstream app repository: https://github.com/tootsuite/mastodon
- * YunoHost website: https://yunohost.org/
-
----
+* Official app website: https://joinmastodon.org/
+* Official admin documentation: https://docs.joinmastodon.org/
+* Upstream app code repository: https://github.com/tootsuite/mastodon
+* YunoHost documentation for this app: https://yunohost.org/app_mastodon
+* Report a bug: https://github.com/YunoHost-Apps/mastodon_ynh/issues
## Developer info
@@ -84,3 +84,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/tes
or
sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file