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

63 lines
2.2 KiB
Markdown
Raw Normal View History

2021-05-10 17:52:42 +02: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.
-->
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
# Cinny for YunoHost
2018-06-28 22:05:35 +02:00
2023-01-30 09:33:06 +01:00
[![Integration level](https://dash.yunohost.org/integration/cinny.svg)](https://dash.yunohost.org/appci/app/cinny) ![Working status](https://ci-apps.yunohost.org/ci/badges/cinny.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/cinny.maintain.svg)
2023-03-30 09:33:01 +02:00
2021-09-17 10:15:00 +02:00
[![Install Cinny with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cinny)
2018-06-28 22:05:35 +02:00
2021-05-10 17:52:42 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
> *This package allows you to install Cinny quickly and simply on a YunoHost server.
2021-05-10 17:52:42 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2018-06-28 22:05:35 +02:00
2021-05-10 17:52:42 +02:00
## Overview
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
A Matrix client focusing primarily on simple, elegant and secure interface.
2018-06-28 22:05:35 +02:00
2021-09-17 19:57:33 +02:00
### Features
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
- A nice and clean interface
- End-to-end Matrix encryption support
- Matrix Spaces support
2018-06-28 22:05:35 +02:00
2023-01-30 09:33:49 +01:00
**Shipped version:** 2.2.4~ynh1
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
**Demo:** https://app.cinny.in
2018-06-28 22:05:35 +02:00
2021-09-17 19:57:33 +02:00
## Screenshots
2018-06-28 22:05:35 +02:00
2022-05-29 11:41:13 +02:00
![Screenshot of Cinny](./doc/screenshots/cinny.jpg)
2018-06-28 22:05:35 +02:00
2021-05-10 17:52:42 +02:00
## Disclaimers / important information
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
* There's no LDAP support (and never will be).
* Cinny only is a client, you need to have an account on a server already (see the Synapse Yunohost app)
2018-06-28 22:05:35 +02:00
2021-05-10 17:52:42 +02:00
## Documentation and resources
2018-06-28 22:05:35 +02:00
2022-05-29 11:41:13 +02:00
* Official app website: <https://cinny.in>
* Official user documentation: <https://cinny.in>
* Official admin documentation: <https://cinny.in>
* Upstream app code repository: <https://github.com/ajbura/cinny>
* YunoHost documentation for this app: <https://yunohost.org/app_cinny>
* Report a bug: <https://github.com/YunoHost-Apps/cinny_ynh/issues>
2018-06-28 22:05:35 +02:00
2020-08-02 15:41:28 +02:00
## Developer info
2018-06-28 22:05:35 +02:00
2021-09-17 10:15:00 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cinny_ynh/tree/testing).
2018-06-28 22:05:35 +02:00
To try the testing branch, please proceed like that.
2022-05-29 11:41:13 +02:00
``` bash
2021-09-17 10:15:00 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/cinny_ynh/tree/testing --debug
2018-06-28 22:05:35 +02:00
or
2021-09-17 10:15:00 +02:00
sudo yunohost app upgrade cinny -u https://github.com/YunoHost-Apps/cinny_ynh/tree/testing --debug
2018-06-28 22:05:35 +02:00
```
2021-05-10 17:52:42 +02:00
2022-05-29 11:41:13 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>