From 34c891c4cfae440f6fd29adc8bfb2ec78daee5df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonas=20Frankem=C3=B6lle?=
 <48800769+FrankJonasmoelle@users.noreply.github.com>
Date: Sat, 24 Aug 2024 12:07:40 +0200
Subject: [PATCH] Docs/SK-953 | README fix for async-clients example (#676)

* fixing readme

* fixing code blocks
---
 .../async-clients/{README.md => README.rst}   | 82 ++++++++++---------
 1 file changed, 45 insertions(+), 37 deletions(-)
 rename examples/async-clients/{README.md => README.rst} (53%)

diff --git a/examples/async-clients/README.md b/examples/async-clients/README.rst
similarity index 53%
rename from examples/async-clients/README.md
rename to examples/async-clients/README.rst
index 12d55ac62..45f4a64a8 100644
--- a/examples/async-clients/README.md
+++ b/examples/async-clients/README.rst
@@ -1,77 +1,85 @@
-# ASYNC CLIENTS 
+ASYNC CLIENTS 
+-------------
+
 This example shows how to experiment with intermittent and asynchronous client workflows.     
 
-## Prerequisites
+Prerequisites
+-------------
+
 - [Python 3.8, 3.9 or 3.10](https://www.python.org/downloads)
 - [Docker](https://docs.docker.com/get-docker)
 - [Docker Compose](https://docs.docker.com/compose/install)
 
-## Running the example (pseudo-distributed, single host)
+Running the example (pseudo-distributed, single host)
+-----------------------------------------------------
+
 
 First, make sure that FEDn is installed (we recommend using a virtual environment)
 
 Clone FEDn
-```sh
-git clone https://github.com/scaleoutsystems/fedn.git
-```
+
+.. code-block::
+
+    git clone https://github.com/scaleoutsystems/fedn.git
 
 Install FEDn and dependencies
 
-``
-pip install fedn
-```
+.. code-block::
 
-Or from source, standing in the folder 'fedn/fedn'
+    pip install fedn
 
-```
-pip install .
-```
 
-### Prepare the example environment, the compute package and seed model
+Prepare the example environment, the compute package and seed model
+-------------------------------------------------------------------
 
 Standing in the folder fedn/examples/async-clients
-```
-pip install -r requirements.txt
-```
+
+.. code-block::
+
+    pip install -r requirements.txt
 
 Create the compute package and seed model:
-```
-fedn package create --path client
-```
 
-```
-fedn run build --path client
-```
+.. code-block::
+
+    fedn package create --path client
+
+.. code-block::
+
+    fedn run build --path client
+
 
 You will now have a file 'seed.npz' in the directory.
 
-### Running a simulation
+Running a simulation
+--------------------
 
 Deploy FEDn on localhost. Standing in the the FEDn root directory: 
 
-```
-docker-compose up 
-```
+.. code-block::
+
+    docker-compose up 
+
 
 Initialize FEDn with the compute package and seed model
 
-```
-python init_fedn.py
-```
+.. code-block::
+
+    python init_fedn.py
 
 Start simulating clients
-```
-python run_clients.py
-```
+
+.. code-block::
+
+    python run_clients.py
 
 Start the experiment / training sessions: 
 
-```
-python run_experiment.py
-```
+.. code-block::
 
-Once global models start being produced, you can start analyzing results using API Client, refer to the notebook "Experiment.ipynb" for instructions. 
+    python run_experiment.py
 
+Once global models start being produced, you can start analyzing results using API Client, refer to the notebook "Experiment.ipynb" for instructions.