bachir/zulip_ynh
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first readme rewriting

Browse Source
This commit is contained in:
bachir
2019-02-19 21:15:21 +01:00
parent 457454849a
commit fd1c9a6c94
1 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -15
View File
@@ -6,28 +6,29 @@
- Add a `LICENSE` file for the package. - Add a `LICENSE` file for the package.
- Edit `README.md` and README_fr.md. - Edit `README.md` and README_fr.md.
# Example app for YunoHost # Zulip app for YunoHost
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) [![Integration level](https://dash.yunohost.org/integration/zulip.svg)](https://dash.yunohost.org/appci/app/zulip)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) [![Install zulip with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=zulip)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. > *This package allow you to install zulip quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview ## Overview
Quick description of this app. Zulip combines the immediacy of real-time chat with an email threading model.
With Zulip, you can catch up on important conversations while ignoring irrelevant ones.
**Shipped version:** 1.0 **Shipped version:** 1.0
## Screenshots ## Screenshots
![](Link to an screenshot for this app) ![](https://zulipchat.com/static/images/features/message-formatting.png)
## Demo ## Demo
* [Official demo](Link to a demo site for this app) * [Official demo](https://chat.zulip.org/login/)
## Configuration ## Configuration
@@ -47,9 +48,9 @@ Can the app be used by multiple users?
#### Supported architectures #### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) * x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/zulip%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/zulip/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/zulip%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/zulip/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/) * Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/zulip%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/zulip/)
## Limitations ## Limitations
@@ -59,12 +60,12 @@ Can the app be used by multiple users?
* Other information you would add about this application * Other information you would add about this application
**More information on the documentation page:** **More information on the documentation page:**
https://yunohost.org/packaging_apps https://yunohost.org/packaging_apps
## Links ## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/zulip_ynh/issues
* App website: Link to the official website of this app * App website: Link to the official website of this app
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
@@ -74,11 +75,11 @@ Developers info
---------------- ----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.** **Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/zulip_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/zulip_ynh/tree/testing --debug
or or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug sudo yunohost app upgrade zulip -u https://github.com/YunoHost-Apps/zulip_ynh/tree/testing --debug
``` ```