From 75298afc2cf619b20a4901141c5dd0d4aee754f8 Mon Sep 17 00:00:00 2001 From: Benjamin Loison Date: Tue, 1 Aug 2023 22:16:13 +0200 Subject: [PATCH] Add Bash syntax highlighting to `README.md` and `docker/README.adoc` --- README.md | 4 ++-- docker/README.adoc | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d135b9e..fff51f4 100644 --- a/README.md +++ b/README.md @@ -471,10 +471,10 @@ and automatically decrypted for you. in [tests/test-send.py]( https://github.com/8go/matrix-commander/blob/master/tests/test-send.py). -``` +```bash $ matrix-commander --login password # first run; will configure everything $ matrix-commander --login sso # alternative first run with Single Sign-On; -$ # this will configure everything on a headless server w/o a browser +$ # this will configure everything on a headless server w/o a browser $ # this created a credentials.json file, and a store directory. $ # optionally, if you want you can move credentials to app config directory $ mkdir $HOME/.config/matrix-commander # optional diff --git a/docker/README.adoc b/docker/README.adoc index cf32686..d9fcc20 100644 --- a/docker/README.adoc +++ b/docker/README.adoc @@ -55,7 +55,7 @@ You can now use this data folder to send messages or verify your session. === Send a message to a room Given an initialized data folder, run this command to send a message to a room: -``` +```bash docker run --rm -v /my/chosen/folder:/data:z matrix-commander -r "" -m "" ``` @@ -73,15 +73,15 @@ When using docker, please understand how docker works with pipes. Read issue htt This has nothing to do with matrix-commander, but nontheless here are some examples. In a nutshell: -``` +```bash df -h | docker run --rm -v ./data:/data matrix-commander --code ``` The above line will *NOT* work. This is not how pipes work in docker. -``` +```bash docker run --rm -ti -v ./data:/data matrix-commander -k -m "$(df -h| head -2)" ``` The above line works, as there is no pipe into docker. -``` +```bash df -h | head -2 | docker run --rm -i -v ./data:/data matrix-commander --code ``` The above line works, because -t is *NOT* used.