diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 25 insertions, 39 deletions
@@ -1,53 +1,39 @@ <!-- -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/master/logos/mastodon.png" width="32px" alt="Logo of Mastodon"> + Mastodon, packaged for YunoHost +</h1> -[](https://ci-apps.yunohost.org/ci/apps/mastodon/) - - +Libre and federated social network -[](https://install-app.yunohost.org/?app=mastodon) +[](https://joinmastodon.org/) +[](https://joinmastodon.org/) +?style=for-the-badge) -*[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.* +## 📦 Developer info -## Overview +🛠️ Upstream Mastodon repository: <https://github.com/mastodon/mastodon> -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. +Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing). +The `testing` branch can be tested using: +``` +# fresh install: +sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing -**Shipped version:** 4.3.6~ynh1 - -**Demo:** <https://joinmastodon.org/> - -## Screenshots - - - -## 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 +# 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 |