mastodon_ynh/README.md

<!--
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) ![Working status](https://ci-apps.yunohost.org/ci/badges/mastodon.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mastodon.maintain.svg)

[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mastodon)

*[Read this README is other languages.](./ALL_README.md)*

> *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.8~ynh2

**Demo:** <https://joinmastodon.org/>

## Screenshots

![Screenshot of Mastodon](./doc/screenshots/mastodon.png)

## Documentation and resources

- 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>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```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
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>