From f0536dc7ea2e56d50e64fa350aee84911b8a27ad Mon Sep 17 00:00:00 2001
From: "Tumbul, Erwin" <erwin.tumbul@student.tugraz.at>
Date: Wed, 8 Jun 2022 21:53:19 +0200
Subject: [PATCH] Update readme. Embed demo.
---
README.md | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index ed6cad6..6a6bec2 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,22 @@
# mobile-sec-notifier
-Two chat participants [A]lice and [B]ob.
-Send encrypted messages indirectly via the server between A and B.
-A and B in distinct networks.
+
+
+* Two chat participants [A]lice and [B]ob.
+* Send encrypted messages indirectly via the server between A and B.
+* A and B in distinct networks.
# Usage
+The default mode of operation requires:
+* A server
+* One python client in receiver mode
+* One android client in sender mode
+
1. Start server with `python server.py`
2. Start client
* Python: `python client.py MODE`, where `MODE` is 0 (receiver) or 1 (sender)
* Android:
- 0. Set notification permissions if necessary.
+ 1. Set notification permissions if necessary.
1. Enter IP address and port of server.
2. Click `Open communication`
3. Enter generated id_code in other client.
@@ -22,10 +29,7 @@ A and B in distinct networks.
* The android client can be started easily with Android Studio.
* Otherwise, there is a built APK available in the folder `releases/`
-## Demo
-There is a demo video available as well.
-
-# TODO:
+# Implemented:
- [x] Protocol
- [x] Server (python)
@@ -56,7 +60,7 @@ There is a demo video available as well.
# Prototype 3:
- [ ] grpc secure connection
-- [ ] Harden against attacks (for reference: https://core.telegram.org/techfaq#protection-against-known-attacks)
+- [x] Harden against attacks (for reference: https://core.telegram.org/techfaq#protection-against-known-attacks)
# TODO:
--
GitLab