mirror of
https://github.com/YunoHost-Apps/hydrogen_ynh.git
synced 2024-09-03 19:26:17 +02:00
56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Hydrogen for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/hydrogen)  
|
|
|
|
[](https://install-app.yunohost.org/?app=hydrogen)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Hydrogen 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
|
|
|
|
A minimal Matrix chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime.
|
|
|
|
### Features
|
|
|
|
- Work well on desktop as well as mobile browsers
|
|
- UI components can be easily used in isolation
|
|
- It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities.
|
|
- Loading (unused) parts of the application after initial page load should be supported
|
|
|
|
|
|
**Shipped version:** 0.4.1~ynh1
|
|
|
|
**Demo:** <https://hydrogen.element.io/>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://matrix.org/ecosystem/clients/hydrogen/>
|
|
- Upstream app code repository: <https://github.com/vector-im/hydrogen-web>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/hydrogen>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/hydrogen_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade hydrogen -u https://github.com/YunoHost-Apps/hydrogen_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|