From 14012029af1b5c2c908d9133f21488b2113535ed Mon Sep 17 00:00:00 2001
From: Roberto Cirillo <roberto.cirillo@isti.cnr.it>
Date: Wed, 11 May 2022 15:20:46 +0200
Subject: [PATCH] update README file

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 24d298a..7cf8064 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,25 @@
 # Pipeline-gCubeDeploy
 
-This is a test: try to implements a deply pipeline integrated with ansible.
+Jenkins Pipeline script to manage one or more gCube components deployment
 
-## USAGE TIPS:
+## Requirements
+* [Jenkins](https://jenkins.io/) ver. 2.164.2 or newer
+* [Pipeline plugin](https://wiki.jenkins.io/display/JENKINS/Pipeline+Plugin)
+* [Pipeline: Maven](https://plugins.jenkins.io/pipeline-maven)
+* [Pipeline: Basic Steps](https://plugins.jenkins.io/workflow-basic-steps) 
+* [Email Extension](https://plugins.jenkins.io/email-ext) (to send emails with attachments)
+* Jenkins slave(s) configured with Ansible ver. 2.9.27 or newer
+* One or more Jenkins agents labeled as 'CD'
 
+## Expected parameters
+
+
+## References 
+* [Jenkins Pipeline](https://jenkins.io/doc/book/pipeline/) 
+* [Pipeline Syntax](https://jenkins.io/doc/book/pipeline/syntax/)
+
+## Wiki doc
+
+
+## License
+This project is licensed under the [EUPL V.1.1 License](LICENSE.md).