From 04200ee09be3849b6c6839e843a9dc45e8f1e695 Mon Sep 17 00:00:00 2001
From: Sebastian Lenzlinger <sebastian.lenzlinger@unibas.ch>
Date: Wed, 17 Jul 2024 13:02:14 +0200
Subject: [PATCH] Add usage examples to README.md.

---
 code/iottb-project/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/code/iottb-project/README.md b/code/iottb-project/README.md
index 90201a9..2cc64e9 100644
--- a/code/iottb-project/README.md
+++ b/code/iottb-project/README.md
@@ -49,6 +49,26 @@ Debugging Commands:
   show-all             Show everything: configuration, databases, and...
   show-cfg             Show the current configuration context
 ```
+
+## Usage Examples
+### Initializing a database
+Before devices can be added and packet captures performed, there must be a database.
+Initialze a database with default values at the default location:
+```bash
+iottb init-db
+```
+### Adding a device
+Typically, captures are performed for devices. To add a device (to the current default database)
+```bash
+iottb add-device 'Echo Dot 2'
+```
+if the devices is named 'Echo Dot 2'. This will get the cannonical name 'echo-dot'. This name should be used when performing
+captures with `iottb`.
+### Performing captures/sniffing traffic
+```bash
+iottb sniff -a <ipv4-addr or mac-addr> 'echo-dot'
+```
+to sniff traffic on the previously added device 'Echo Dot 2' which received the canonical name 'echo-dot'.
 You can get the subcommand specif helptext by adding the `--help` option.
 ## Configuration
 ### Env Vars