From f098dc867a73d62955507182f49e7569b86e8b27 Mon Sep 17 00:00:00 2001
From: Jokler <jokler@protonmail.com>
Date: Sun, 22 Mar 2020 21:21:12 +0100
Subject: Update README.md and add compilation instructions

---
 Cargo.lock |  2 +-
 README.md  | 30 +++++++++++++++++++++++++-----
 2 files changed, 26 insertions(+), 6 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 9117117..c247b39 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2353,7 +2353,7 @@ checksum = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677"
 
 [[package]]
 name = "pokebot"
-version = "0.1.1"
+version = "0.2.0"
 dependencies = [
  "actix",
  "actix-files",
diff --git a/README.md b/README.md
index 0454203..b904143 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # pokebot
 
 ```
-pokebot 0.1.1
+pokebot 0.2.0
 Jokler <jokler@protonmail.com>
 
 USAGE:
@@ -14,14 +14,15 @@ FLAGS:
     -v, --verbose    Print the content of all packets
 
 OPTIONS:
-    -a, --address <address>                     The address of the server to connect to
-    -g, --generate-identities <gen_id_count>    Generate 'count' identities
-    -d, --master_channel <master_channel>       The channel the master bot should connect to
+    -a, --address <address>                         The address of the server to connect to
+    -g, --generate-identities <gen_id_count>        Generate 'count' identities
+    -d, --master_channel <master_channel>           The channel the master bot should connect to
+    -w, --increase-security-level <wanted_level>    Increases the security level of all identities in the config file
 
 ARGS:
     <config_path>    Configuration file [default: config.toml]
 ```
-# Usage
+## Usage
 
  1. Poke the main bot.
  2. Once the secondary bot joins your channel, type !help for a list of commands.
@@ -40,3 +41,22 @@ ARGS:
     stop      Stops audio playback
     volume    Changes the volume to the specified value
  ```
+
+## Compiling
+
+1. Make sure the following are installed
+    * cargo + rustc 1.42 or later
+    * `gstreamer` development libraries which should be `libgstreamer-dev` and `libgstreamer-plugins-base-dev`
+
+2. Clone the source with `git`:
+    ```sh
+    $ git clone https://github.com/Mavulp/pokebot.git
+    $ cd pokebot
+    ```
+
+3. Building the binary
+    ```sh
+    $ cargo build --release
+    ```
+
+    This creates the binary under `target/release/`.
-- 
cgit v1.2.3-70-g09d2