From 3907a0208b4449e7e12589f59e864e32c9e6d40e Mon Sep 17 00:00:00 2001
From: Alexander <alexander.bodard@student.kuleuven.be>
Date: Mon, 21 Nov 2022 10:33:10 +0100
Subject: [PATCH] Update README.md

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7154cd9..0a54b63 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
 # spock.jl
 
-A proximal solver for the solution of multistage risk-averse optimal control problems
\ No newline at end of file
+`spock.jl` is an efficient Julia implementation of the Spock algorithm for multistage risk-averse optimal control problems. It largely benefits from warm-starts and is amenable to massive parallelization.
+
+This solver handles risk-averse optimal control problems with:
+
+  - Linear dynamics
+  - Quadratic stage and terminal costs
+  - Conic risk measures
+  - Convex input-state constraints
+
+## Installation
+
+Make sure to install the dependencies in the `Project.toml` and in your script import
+
+```
+include("src/spock.jl")
+```
+
+
+## Examples
+
+The `examples/server_heat` folder contains example code for a test system, modeling the heat of servers in a data center. The figures in the IFAC 2023 submission can be reproduced by running the scripts `residuals.jl`, `scaling.jl` and `mpc_simulation.jl`.