From 5240ad3fe3d762e0797130702da7d677555ecc80 Mon Sep 17 00:00:00 2001 From: Felix Prahl-Kamps Date: Thu, 4 Jul 2019 14:36:42 +0200 Subject: [PATCH] improve readme with screenshots --- README.md | 57 ++++++++++++++++++ .../mispbump-home-0.png | Bin .../mispbump-home.png | Bin .../mispbump-profile.png | Bin .../mispbump-sync-0.png | Bin .../mispbump-sync-1.png | Bin .../mispbump-sync-2.png | Bin .../mispbump-sync-3.png | Bin .../mispbump-sync-info-credentials.png | Bin .../mispbump-sync-info-settings.png | Bin .../mispbump-upload-0.png | Bin .../mispbump-upload-1.png | Bin .../mispbump-upload-2.png | Bin 13 files changed, 57 insertions(+) rename {Screenshots => screenshots}/mispbump-home-0.png (100%) rename {Screenshots => screenshots}/mispbump-home.png (100%) rename {Screenshots => screenshots}/mispbump-profile.png (100%) rename {Screenshots => screenshots}/mispbump-sync-0.png (100%) rename {Screenshots => screenshots}/mispbump-sync-1.png (100%) rename {Screenshots => screenshots}/mispbump-sync-2.png (100%) rename {Screenshots => screenshots}/mispbump-sync-3.png (100%) rename {Screenshots => screenshots}/mispbump-sync-info-credentials.png (100%) rename {Screenshots => screenshots}/mispbump-sync-info-settings.png (100%) rename {Screenshots => screenshots}/mispbump-upload-0.png (100%) rename {Screenshots => screenshots}/mispbump-upload-1.png (100%) rename {Screenshots => screenshots}/mispbump-upload-2.png (100%) diff --git a/README.md b/README.md index e4babc8..5458fee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,60 @@ +# Screenshots + +## Home +Entrypoint of the app. + +Actions: **Profile View** (Menubar) and **New Sync** (Floating Action Button) + +![Home (Empty)](./screenshots/mispbump-home-0.png) + +## Profile +Basic information about the organisation that is currently logged in. + +Actions: **Delete and logout** (Menubar) and **Update Info** (Floating Action Button) + +![Profile](./screenshots/mispbump-profile.png) + +## Sync + +Core functionality of MISPbump. + +**First Step:** Exchange keys to derive a shared secret + +![Profile](./screenshots/mispbump-sync-0.png) +![Profile](./screenshots/mispbump-sync-1.png) + +**Second Step:** Exchange encrypted sync information + +![Profile](./screenshots/mispbump-sync-2.png) +![Profile](./screenshots/mispbump-sync-3.png) + +## Sync information + +After a successfull exchange an entry for this organisation will appear. + +Actions: **Delete Sync information** (Menubar) and **Upload** (Floating Action Button in settings tab) + +**Credentials:** With this credentials you will be able to log in on the other MISP instance (SyncUser) + +![Profile](./screenshots/mispbump-sync-info-credentials.png) + +**Settings:** These are typical settings which are also available from the MISP web interface. + +![Profile](./screenshots/mispbump-sync-info-settings.png) + +## Upload + +Shows the status of the upload to your MISP instance. +If errors occure they will be displayed and the user can restart the process. + +![Profile](./screenshots/mispbump-upload-1.png) +![Profile](./screenshots/mispbump-upload-2.png) + +## Home with successfull sync + +![Home (Synced)](./screenshots/mispbump-home.png) + + # What does this app? 1. Exchange public keys to make following communication private (via QR code) + Diffie Hellman key exchange diff --git a/Screenshots/mispbump-home-0.png b/screenshots/mispbump-home-0.png similarity index 100% rename from Screenshots/mispbump-home-0.png rename to screenshots/mispbump-home-0.png diff --git a/Screenshots/mispbump-home.png b/screenshots/mispbump-home.png similarity index 100% rename from Screenshots/mispbump-home.png rename to screenshots/mispbump-home.png diff --git a/Screenshots/mispbump-profile.png b/screenshots/mispbump-profile.png similarity index 100% rename from Screenshots/mispbump-profile.png rename to screenshots/mispbump-profile.png diff --git a/Screenshots/mispbump-sync-0.png b/screenshots/mispbump-sync-0.png similarity index 100% rename from Screenshots/mispbump-sync-0.png rename to screenshots/mispbump-sync-0.png diff --git a/Screenshots/mispbump-sync-1.png b/screenshots/mispbump-sync-1.png similarity index 100% rename from Screenshots/mispbump-sync-1.png rename to screenshots/mispbump-sync-1.png diff --git a/Screenshots/mispbump-sync-2.png b/screenshots/mispbump-sync-2.png similarity index 100% rename from Screenshots/mispbump-sync-2.png rename to screenshots/mispbump-sync-2.png diff --git a/Screenshots/mispbump-sync-3.png b/screenshots/mispbump-sync-3.png similarity index 100% rename from Screenshots/mispbump-sync-3.png rename to screenshots/mispbump-sync-3.png diff --git a/Screenshots/mispbump-sync-info-credentials.png b/screenshots/mispbump-sync-info-credentials.png similarity index 100% rename from Screenshots/mispbump-sync-info-credentials.png rename to screenshots/mispbump-sync-info-credentials.png diff --git a/Screenshots/mispbump-sync-info-settings.png b/screenshots/mispbump-sync-info-settings.png similarity index 100% rename from Screenshots/mispbump-sync-info-settings.png rename to screenshots/mispbump-sync-info-settings.png diff --git a/Screenshots/mispbump-upload-0.png b/screenshots/mispbump-upload-0.png similarity index 100% rename from Screenshots/mispbump-upload-0.png rename to screenshots/mispbump-upload-0.png diff --git a/Screenshots/mispbump-upload-1.png b/screenshots/mispbump-upload-1.png similarity index 100% rename from Screenshots/mispbump-upload-1.png rename to screenshots/mispbump-upload-1.png diff --git a/Screenshots/mispbump-upload-2.png b/screenshots/mispbump-upload-2.png similarity index 100% rename from Screenshots/mispbump-upload-2.png rename to screenshots/mispbump-upload-2.png