- format readme

.github/workflows/cyber.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         go-version: [1.16]
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
 
@@ -28,5 +28,6 @@ jobs:
         go-version: ${{ matrix.go-version }}
 
     - name: Build
+      if:  github.event_name == 'push' && (matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest')
       run: cd riotpot && go build -o bin/ -v
 

README.md

@@ -1,21 +1,26 @@
-# riotpot
+<div style="text-align:center">
+  <img href="AAUgrapgics/aau_logo.png" height="100" width="100">
+</div> 
+
+# Riotpot
 
 <p align="left">
   <a href="https://github.com/aau-network-security/riotpot/actions"><img alt="GitHub Actions status" src="https://github.com/aau-network-security/riotpot/workflows/cyber/badge.svg"></a> 
 </p>
 
-Resilient IoT Hoeypot
+# Table of Contents
+- [Riotpot](#riotpot)
+- [Table of Contents](#table-of-contents)
+- [1. Description](#1-description)
+- [2. Installation](#2-installation)
+
 
-# Emulators
+# 1. Description
+Riotpot is an interoperable medium interaction honeypot, primarly focused on the emulation IoT and OT protocols, althoug, it is also capable of emulating other services.
 
-Riotpot offers a diverse set of protocol emulators:
-- HTTP
-- SSH
-- MQTT
-- TELNET
-- ECHO
+This services are loaded in the honeypot in the form of plugins, making Riotpot a modular, and very transportable honeypot. The services are loaded at runtime, meaning that the weight of the honeypot will vary on premisses, and the services loaded e.g. HTTP, will only be used when required.
 
-# Usage
+# 2. Installation
 
 Docker container:
 ```bash
@@ -30,4 +35,6 @@ go build -o bin/
 Specific file testing (e.g. plugins):
 ```bash
 go run Path
-```
+```
+
+<img href="AAUgrapgics/aau_waves.png" width="100%" height="100">