From beaea5d35626343f729eb6aa29ce7f202c4d00a0 Mon Sep 17 00:00:00 2001
From: Era Dorta <era.xama@protonmail.com>
Date: Sat, 21 May 2022 18:58:18 +0200
Subject: [PATCH] Consistent nomenclature in readme

---
 README.md | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 2914afd..db66b3e 100644
--- a/README.md
+++ b/README.md
@@ -23,32 +23,32 @@ The only required dependency is [docker](https://www.docker.com/).
   * ```bash
     docker run -v "./data/signald:/signald" signald/signald:0.18.5-non-root
     ```
-* Open a second terminal inside the container to configure signald
+* Open a second terminal inside the container to configure signald, substitute \<container name\> with the container name
   * ```bash
     docker exec -it <container name> bash
     ```
 * Link **or** register the phone number
   * Linking (easier)
-    * Run the link command and scan the QR code
+    * Run the link command and scan the QR code, substitute \<Your phone number\> with your phone number
       * ```bash
-        signaldctl account link "Your phone number"
+        signaldctl account link <Your phone number>
         ```
   * Registering (harder)
     * Get the captcha helper from here https://gitlab.com/signald/captcha-helper
       * Run captcha helper ```bash
                            ./signal-captcha-helper
                            ```
-    * Register the account using the captcha (substitue nnnnn for the captcha output)
+    * Register the account using the captcha (substitue \<nnnnn\> for the captcha output)
       * ```bash
-        signaldctl account register "Your phone number" --captcha nnnnn
+        signaldctl account register <Your phone number> --captcha <nnnnn>
         ```
-    * Verify the account (substitute nnnnn for the sms verification code)
+    * Verify the account (substitute \<nnnnn\> for the sms verification code)
       * ```bash
-        signaldctl account verify "Your phone number" nnnnn
+        signaldctl account verify <Your phone number> <nnnnn>
         ```
-* Verify that signald is properly configured (substitute target for who you are sending the message to, and "a message" with your message) 
+* Verify that signald is properly configured 
   * ```bash
-    signaldctl message send -a "Your phone number" target "a message"
+    signaldctl message send -a <Your phone number> <recipient phone number> <a message>
     ```
 * Once signald is configured, lets run a container with signalblast
   * ```bash
@@ -56,11 +56,11 @@ The only required dependency is [docker](https://www.docker.com/).
        --restart=unless-stopped \
        -v "./data/signalblast:/home/user/signalblast/signalblast/data" \
        -v "./data/signald:/home/user/signald" \
-       -e SIGNAL_PHONE_NUMBER="Your phone number" \
+       -e SIGNAL_PHONE_NUMBER=<Your phone number> \
        eraxama/signalblast:latest
     ```
   * There are two optional parameters
-    * `-e SIGNALBLAST_PASSWORD="a password"` -> the admin password for signalblast
-    * `-e SIGNALBLAST_EXPIRATION_TIME="time"` -> an automatic message expiration time in seconds
+    * `-e SIGNALBLAST_PASSWORD=<a password>` -> the admin password for signalblast
+    * `-e SIGNALBLAST_EXPIRATION_TIME=<time>` -> an automatic message expiration time in seconds
 * Now you can send message to the bot, a good first message is `!help`. The bot should reply immediately.
 * If this is not the case, check the logs at `./data/signalblast/signalblast.log`