1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/iceshrimp_ynh.git synced 2024-09-03 19:15:54 +02:00
iceshrimp_ynh/README.md

49 lines
2 KiB
Markdown
Raw Normal View History

2023-12-20 19:03:04 +01:00
<!--
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.
-->
2023-12-20 19:09:16 +01:00
# Iceshrimp for YunoHost
2023-12-20 19:03:04 +01:00
2023-12-20 19:09:16 +01:00
[![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)
2023-12-20 19:03:04 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2023-12-20 19:09:16 +01:00
> *This package allows you to install Iceshrimp quickly and simply on a YunoHost server.
2023-12-20 19:03:04 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-12-20 19:09:16 +01:00
Iceshrimp is a decentralized and federated social networking service, implementing the ActivityPub standard.
2023-12-20 19:03:04 +01:00
2023-12-20 19:09:16 +01:00
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.
2023-12-20 19:03:04 +01:00
2023-12-21 18:59:46 +01:00
**Shipped version:** 2023~ynh1
2023-12-20 19:03:04 +01:00
## Screenshots
2023-12-20 19:09:16 +01:00
![Screenshot of Iceshrimp](./doc/screenshots/example.jpg)
2023-12-20 19:03:04 +01:00
## Documentation and resources
2023-12-20 19:09:16 +01:00
* 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>
2023-12-20 19:03:04 +01:00
## Developer info
2023-12-20 19:09:16 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing).
2023-12-20 19:03:04 +01:00
To try the testing branch, please proceed like that.
``` bash
2023-12-20 19:09:16 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
2023-12-20 19:03:04 +01:00
or
2023-12-20 19:09:16 +01:00
sudo yunohost app upgrade iceshrimp -u https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
2023-12-20 19:03:04 +01:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>