From 8646996d6b486e9609e2ffa00dbfe707558f59a5 Mon Sep 17 00:00:00 2001
From: Tommaso Tedeschi <tedesk95@gmail.com>
Date: Tue, 16 Apr 2024 12:05:36 +0200
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index 16b85f3..b529d9e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
+# InterLink HTCondor sidecar
+
+This repo contains the code of an InterLink HTCondor sidecar, i.e. a container manager plugin which interacts with
+ an [InterLink](https://github.com/interTwin-eu/interLink/tree/main) instance and allows the deployment of pod's
+ singularity containers on a local or remote HTCondor batch system.
+
+## Quick start
+
+First of all, let's download this repo:
+
+```bash
+git clone https://github.com/ttedeschi/InterLink_HTCondor_sidecar.git
+```
+
+modify the [config file](SidecarConfig.yaml) properly.
+Then to run the server you just have to enter:
+
+```bash
+cd InterLink_HTCondor_sidecar
+python3 handles.py --condor-config <path_to_condor_config_file> --schedd-host <schedd_host_url> --collector-host <collector_host_url> --auth-method <authentication_method> --debug <debug_option> --proxy <path_to_proxyfile> --port <server_port>
+```
+
+It will be served by default at `http://0.0.0.0:8000/`. In case of GSI authentication, certificates should be placed in `/etc/grid-security/certificates`.
+
+If Virtual Kubelet and Interlink instances are running and properly configured, you can then test deploying:
+
+```bash
+kubectl apply -f ./tests/test_configmap.yaml
+kubectl apply -f ./tests/test_secret.yaml
+kubectl apply -f ./tests/busyecho_k8s.yaml
+```
+
+A special behaviour is triggered if the image is in the form `host`.
+The plugin will submit the script which is passed as argument:
+
+```bash
+kubectl apply -f ./tests/production_deployment_LNL.yaml
+```
+
 # Template for interTwin repositories
 
 This repository is to be used as a repository template for creating a new interTwin