YunoHost-Apps/biboumi_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/biboumi_ynh.git synced 2024-09-03 18:15:58 +02:00
Code Issues Activity Actions

[mod] Customized README.

Browse source
This commit is contained in:
pitchum 2018-08-30 14:25:24 +02:00
parent 7c845133b4
commit 19bce2585d
1 changed files with 18 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
README.md
View file

@ -1,31 +1,28 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Add a `LICENSE` file for the package.
- Edit `README.md`.
# Biboumi app for Yunohost
# Example app for YunoHost
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20%28Community%29/lastBuild/consoleFull)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
<!--
[![Integration level](https://dash.yunohost.org/integration/biboumi_ynh.svg)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20%28Community%29/lastBuild/consoleFull)
[![Install biboumi_ynh with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
-->
> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
> *This package allows you to install biboumi 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.*
## Overview
Quick description of this app.
**Shipped version:** 1.0
Biboumi is an XMPP gateway for the IRC network.
## Screenshots
Once biboumi_ynh is installed you can use any XMMP client software to
join IRC channels. Any IRC channel is seen as a standard XMMP chatroom
(aka MUC) with a special name.
The the name is formatted like this: `#channelname%ircservername@biboumi.yourdomain.tld`.
![](Link to an screenshot for this app)
For example, if you have a yunohost server hosting domain *example.net*
and you want to join the channel *#yunohost* on *irc.freenode.net* you
simply need to join the MUC `#yunohost%irc.freenode.net@biboumi.example.net`.
## Demo
* [Official demo](Link to a demo site for this app)
**Shipped version:** 8.0
## Configuration
@ -33,50 +30,14 @@ How to configure this app: by an admin panel, a plain file with SSH, or any othe
## Documentation
* Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-users support
Are LDAP and HTTP auth supported?
Can the app be used by multiple users?
#### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/REPLACEBYYOURAPP%20(Community)%20(%7EARM%7E)/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/jenkins/job/REPLACEBYYOURAPP%20(Community)/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/REPLACEBYYOURAPP%20(Community)/)
* Official documentation: https://lab.louiz.org/louiz/biboumi/blob/8.0/doc/biboumi.1.rst
## Limitations
* Any known limitations.
## Additional information
* Other information you would add about this application
**More information on the documentation page:**
https://yunohost.org/packaging_apps
* Currently, biboumi is only tested with one domain and it must be the main domain of your yunohost server.
## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* Report a bug: https://github.com/YunoHost-Apps/biboumi_ynh/issues
* App website: Link to the official website of this app
* YunoHost website: https://yunohost.org/
---
Developers info
----------------
**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).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
```