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

58 lines
2.1 KiB
Markdown
Raw Normal View History

2022-09-12 20:00:09 +02:00
<!--
2024-06-16 09:16:37 +02:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-09-12 20:00:09 +02:00
It shall NOT be edited by hand.
-->
2022-09-12 20:00:14 +02:00
# Chitchatter for YunoHost
2022-09-12 20:00:09 +02:00
2023-01-24 16:39:32 +01:00
[![Integration level](https://dash.yunohost.org/integration/chitchatter.svg)](https://dash.yunohost.org/appci/app/chitchatter) ![Working status](https://ci-apps.yunohost.org/ci/badges/chitchatter.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/chitchatter.maintain.svg)
2023-02-23 16:56:33 +01:00
2022-09-12 20:00:14 +02:00
[![Install Chitchatter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chitchatter)
2022-09-12 20:00:09 +02:00
2024-06-16 09:16:37 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2022-09-12 20:00:09 +02:00
2024-06-16 09:16:37 +02:00
> *This package allows you to install Chitchatter 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.*
2022-09-12 20:00:09 +02:00
## Overview
2022-09-12 20:00:14 +02:00
Chitchatter is a free (as in both price and freedom) communication tool. It is designed with security and privacy in mind.
2022-09-12 20:00:09 +02:00
2022-09-12 20:06:38 +02:00
### Features
2022-09-12 20:00:09 +02:00
2022-09-12 20:00:14 +02:00
- Fully open source (licensed under GPL v2)
- Peer-to-peer
- Encrypted (via WebRTC)
- Serverless
- Ephemeral
- Decentralized
2022-09-12 20:00:09 +02:00
2024-06-16 09:17:37 +02:00
**Shipped version:** 1.0~ynh11
2022-09-12 20:00:09 +02:00
2024-06-16 09:16:37 +02:00
**Demo:** <https://chitchatter.im/>
2022-09-12 20:00:09 +02:00
2022-09-12 20:00:14 +02:00
## Screenshots
2022-09-12 20:00:09 +02:00
2022-09-12 20:00:14 +02:00
![Screenshot of Chitchatter](./doc/screenshots/screenshot.png)
2022-09-12 20:00:09 +02:00
## Documentation and resources
2024-06-16 09:16:37 +02:00
- Official app website: <https://chitchatter.im/>
- Upstream app code repository: <https://github.com/jeremyckahn/chitchatter>
- YunoHost Store: <https://apps.yunohost.org/app/chitchatter>
- Report a bug: <https://github.com/YunoHost-Apps/chitchatter_ynh/issues>
2022-09-12 20:00:09 +02:00
## Developer info
2024-06-16 09:16:37 +02:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/chitchatter_ynh/tree/testing).
2022-09-12 20:00:09 +02:00
2024-06-16 09:16:37 +02:00
To try the `testing` branch, please proceed like that:
2022-09-12 20:00:09 +02:00
2024-06-16 09:16:37 +02:00
```bash
2022-09-12 20:00:14 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/chitchatter_ynh/tree/testing --debug
2022-09-12 20:00:09 +02:00
or
2022-09-12 20:00:14 +02:00
sudo yunohost app upgrade chitchatter -u https://github.com/YunoHost-Apps/chitchatter_ynh/tree/testing --debug
2022-09-12 20:00:09 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>