From bd30bab096135955be364570604cdd43db69975a Mon Sep 17 00:00:00 2001
From: jamesshort1 <107395948+jamesshort1@users.noreply.github.com>
Date: Thu, 27 Jul 2023 08:59:24 +0100
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 326cc27e..40d49c11 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,34 @@
 
 PrimAITE (Primary-level AI Training Environment) is a simulation environment for training AI under the ARCD programme.
 
+The ARCD Primary-level AI Training Environment (PrimAITE) provides an effective simulation capability for the purposes of training and evaluating AI in a cyber-defensive role. It incorporates the functionality required of a primary-level ARCD environment, which includes: 
+
+- The ability to model a relevant platform / system context; 
+
+- The ability to model key characteristics of a platform / system by representing connections, IP addresses, ports, traffic loading, operating systems, services and processes; 
+
+- Operates at machine-speed to enable fast training cycles.
+
+PrimAITE presents the following features: 
+
+- Highly configurable (via YAML files) to provide the means to model a variety of platform / system laydowns and adversarial attack scenarios; 
+
+- A Reinforcement Learning (RL) reward function based on (a) the ability to counter the specific modelled adversarial cyber-attack, and (b) the ability to ensure success; 
+
+- Provision of logging to support AI evaluation and metrics gathering; 
+
+- Uses the concept of Information Exchange Requirements (IERs) to model background pattern of life and adversarial behaviour; 
+
+- An Access Control List (ACL) function, mimicking the behaviour of a network firewall, is applied across the model, following standard ACL rule format (e.g. DENY/ALLOW, source IP address, destination IP address, protocol and port);  
+
+- Application of IERs to the platform / system laydown adheres to the ACL ruleset; 
+
+- Presents an OpenAI gym or RLLib interface to the environment, allowing integration with any OpenAI gym compliant defensive agents;  
+
+- Full capture of discrete logs relating to agent training (full system state, agent actions taken, instantaneous and average reward for every step of every episode)​; 
+
+- NetworkX provides laydown visualisation capability.  
+
 ## Getting Started with PrimAITE
 
 ### 💫 Install & Run