From 695eb61dc4b654d302f5b7a85b1cc7cb58692cc7 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 17 Aug 2021 20:22:37 +0200 Subject: [PATCH] Apply example_ynh --- doc/.gitkeep | 0 doc/DISCLAIMER.md | 10 ++++++++++ doc/screenshots/.gitkeep | 0 manifest.json | 6 ++++++ 4 files changed, 16 insertions(+) create mode 100644 doc/.gitkeep create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/screenshots/.gitkeep diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..728a23b --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,10 @@ +Once biboumi_ynh is installed you can use any XMPP client software to join IRC channels. Any IRC channel is seen as a standard XMPP chatroom (aka MUC) with a special name. +The the name is formatted like this: `#channelname%ircservername@biboumi.yourdomain.tld`. + +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`. + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * Currently, Biboumi is only tested with one domain and it must be the main domain of your YunoHost server. + +* Other infos that people should be aware of, such as: + * You can configure Biboumi with the file `/etc/biboumi/biboumi.cfg`. diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/manifest.json b/manifest.json index 3015cf0..fe33aa1 100644 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,12 @@ }, "version": "8.3~ynh1", "url": "https://biboumi.louiz.org/", + "upstream": { + "license": "Zlib", + "website": "https://biboumi.louiz.org/", + "admindoc": "Official documentation: https://lab.louiz.org/louiz/biboumi/blob/8.3/doc/biboumi.1.rst", + "code": "https://lab.louiz.org/louiz/biboumi" + }, "license": "Zlib", "maintainer": { "name": "pitchum",