Don’t wrap the lines in docker/README.md

docker/biboumi/README.md

@@ -4,13 +4,9 @@ Biboumi Docker Image
 Running
 -------
 
-This image does not embed any XMPP server. You need to have a running XMPP
+This image does not embed any XMPP server. You need to have a running XMPP server first: as an other docker image, or running on the host machine.
-server first: as an other docker image, or running on the host machine.
 
-Assuming you have a running [prosody](https://hub.docker.com/r/prosody/prosody/)
+Assuming you have a running [prosody](https://hub.docker.com/r/prosody/prosody/) container already running and [properly configured](https://prosody.im/doc/components#adding_an_external_component) you can use the following command to start your biboumi container.
-container already running and
-[properly configured](https://prosody.im/doc/components#adding_an_external_component)
-you can use the following command to start your biboumi container.
 
 ```
 docker run --link prosody:xmpp \
@@ -21,8 +17,7 @@ docker run --link prosody:xmpp \
     biboumi
 ```
 
-If instead you already have an XMPP server running on the host machine, you
+If instead you already have an XMPP server running on the host machine, you can start the biboumi container like this:
-can start the biboumi container like this:
 
 ```
 docker run --network=host \
@@ -37,19 +32,16 @@ docker run --network=host \
 Variables
 ---------
 
-The configuration file inside the image is a template that is completed when
+The configuration file inside the image is a template that is completed when the container is started, using the following environment variables:
-the container is started, using the following environment variables:
 
 * BIBOUMI_HOSTNAME: Sets the value of the *hostname* option.
 * BIBOUMI_SECRET: Sets the value of the *password* option.
 * BIBOUMI_ADMIN: Sets the value of the *admin* option.
 * BIBOUMI_XMPP_SERVER_IP: Sets the value of the *xmpp_server_ip* option. The default is **xmpp**.
 
-All these variables are optional, but biboumi will probably fail to start if
+All these variables are optional, but biboumi will probably fail to start if the hostname and secret are missing.
-the hostname and secret are missing.
 
-You can also directly provide your own configuration file by mounting it
+You can also directly provide your own configuration file by mounting it inside the container using the -v option:
-inside the container using the -v option:
 
 ```
 docker run --link prosody:xmpp \
@@ -60,18 +52,11 @@ docker run --link prosody:xmpp \
 Linking with the XMPP server
 ----------------------------
 
-You can use the --link option to connect to any server running in a docker
+You can use the --link option to connect to any server running in a docker container, but it needs to be called *xmpp*, or the custom value set for the **BIBOUMI_XMPP_SERVER_IP** option. For example, if you are using a container named ejabberd, you would use the option *--link ejabberd:xmpp*.
-container, but it needs to be called *xmpp*, or the custom value set for the
-**BIBOUMI_XMPP_SERVER_IP** option. For example, if you are using a container
-named ejabberd, you would use the option *--link ejabberd:xmpp*.
 
-If you want to connect to the XMPP server running on the host machine, use
+If you want to connect to the XMPP server running on the host machine, use the **--network=host** option.
-the **--network=host** option.
 
 Volumes
 -------
 
-The database is stored in the /var/lib/biboumi/ directory. If you don’t bind
+The database is stored in the /var/lib/biboumi/ directory. If you don’t bind a local directory to it, the database will be lost when the container is stopped. If you want to keep your database between each run, bind it with the -v option, like this: **-v /srv/biboumi/:/var/lib/biboumi**.
-a local directory to it, the database will be lost when the container is
-stopped. If you want to keep your database between each run, bind it with
-the -v option, like this: **-v /srv/biboumi/:/var/lib/biboumi**.